summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbhay Agarwal <ay.agarwal@samsung.com>2021-04-12 13:21:39 +0530
committerDoHyun Pyun <dh79.pyun@samsung.com>2021-04-14 15:23:47 +0900
commit7203d74f360fc282c1ba1b4dbb004e89198b425f (patch)
treed5e50698be7b5d783c2e018063e67ae45feade73
parent487843f344c9ec6a11b5f324a84961532d28d56a (diff)
downloaduser-awareness-7203d74f360fc282c1ba1b4dbb004e89198b425f.tar.gz
user-awareness-7203d74f360fc282c1ba1b4dbb004e89198b425f.tar.bz2
user-awareness-7203d74f360fc282c1ba1b4dbb004e89198b425f.zip
Update documentation and header files
Change-Id: Ie0bf7690957faa146d742a8622497c53b1eb8aa6 Signed-off-by: Abhay Agarwal <ay.agarwal@samsung.com>
-rw-r--r--doc/user-awareness-doc.h6
-rwxr-xr-xinclude/user-awareness-type.h16
-rwxr-xr-xinclude/user-awareness.h85
3 files changed, 80 insertions, 27 deletions
diff --git a/doc/user-awareness-doc.h b/doc/user-awareness-doc.h
index 8eed4ee..b4aa189 100644
--- a/doc/user-awareness-doc.h
+++ b/doc/user-awareness-doc.h
@@ -35,13 +35,13 @@
* This API is related with the following features:\n
* - %http://tizen.org/feature/user_awareness\n
*
- * It is recommended to design applications with regard to features, for reliability.\n
+ * It is recommended to design feature related codes in your application for reliability.\n
*
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
*
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
*
- * More details on using features in your application can be found in the <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>feature element description</b></a>."
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
*
*/
diff --git a/include/user-awareness-type.h b/include/user-awareness-type.h
index ce022c1..bd0328d 100755
--- a/include/user-awareness-type.h
+++ b/include/user-awareness-type.h
@@ -94,16 +94,18 @@ extern "C" {
/**
* @ingroup CAPI_NETWORK_UA_MODULE
* @brief Window step multiplier.
+ * @details Detection window step is 5 seconds.
* @since_tizen 6.5
*/
-#define UA_DETECTION_WINDOW_STEP 5 /* 5 seconds */
+#define UA_DETECTION_WINDOW_STEP 5
/**
* @ingroup CAPI_NETWORK_UA_MODULE
* @brief Detection cycle multiplier.
+ * @details Detection cycle step is 60 seconds.
* @since_tizen 6.5
*/
-#define UA_DETECTION_CYCLE_STEP 60 /* 1 min */
+#define UA_DETECTION_CYCLE_STEP 60
/**
* @ingroup CAPI_NETWORK_UA_MODULE
@@ -146,7 +148,7 @@ typedef enum {
UA_SENSOR_MOTION = 0x00000008, /**< Motion Sensor */
UA_SENSOR_LIGHT = 0x00000010, /**< Light Sensor */
UA_SENSOR_AUDIO = 0x00000020, /**< Audio Sensor */
- UA_SENSOR_MAX, /**< Sensor Max. */
+ UA_SENSOR_MAX = 0x10000000,
UA_SENSOR_ALL = 0xFFFFFFFF /**< All sensors */
} ua_sensor_type_e;
@@ -184,7 +186,7 @@ typedef enum {
UA_MAC_TYPE_BLE = 0x02, /**< BLE MAC */
UA_MAC_TYPE_WIFI = 0x04, /**< Wi-Fi station mode MAC */
UA_MAC_TYPE_P2P = 0x08, /**< Wi-Fi P2P mode MAC */
- UA_MAC_TYPE_INVALID /**< Invalid MAC type */
+ UA_MAC_TYPE_INVALID = 0x10000000
} ua_mac_type_e;
/**
@@ -324,7 +326,7 @@ typedef void (*ua_scan_completed_cb)(
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * The result values can be
+ * @details Following error codes can be delivered:
* #UA_ERROR_NONE Successful.
* #UA_ERROR_OPERATION_FAILED Operation failed
*
@@ -362,7 +364,7 @@ typedef void (*ua_presence_detected_cb)(
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * The result values can be
+ * @details Following error codes can be delivered:
* #UA_ERROR_NONE Successful.
* #UA_ERROR_OPERATION_FAILED Operation failed
*
@@ -456,7 +458,7 @@ typedef bool (*ua_service_user_cb)(
*
* @param[in] result The result error code of the requested operation.
* result is #UA_ERROR_NONE on success, otherwise appropriate error value.
- * The result values can be
+ * @details Following error codes can be delivered:
* #UA_ERROR_NONE Successful.
* #UA_ERROR_OPERATION_FAILED Operation failed
*
diff --git a/include/user-awareness.h b/include/user-awareness.h
index ce616cb..082458d 100755
--- a/include/user-awareness.h
+++ b/include/user-awareness.h
@@ -47,6 +47,7 @@ extern "C" {
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_ALREADY_DONE Already initialized
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_deinitialize()
*/
@@ -61,6 +62,7 @@ int ua_initialize(void);
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
* @retval #UA_ERROR_ALREADY_DONE Already initialized
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_initialize()
*/
@@ -78,6 +80,7 @@ int ua_deinitialize(void);
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_cb()
*/
@@ -91,7 +94,7 @@ int ua_foreach_service(
* @since_tizen 6.5
*
* @remarks The @a service handle is managed by the platform and will be released
- * when #ua_deinitialize() is called.
+ * when ua_deinitialize() is called.
* @param[out] service The service handle
*
* @return 0 on success, otherwise a negative error value
@@ -99,9 +102,10 @@ int ua_foreach_service(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_get_name()
- * @see ua_service_set_name()
+ * @see ua_service_create()
*/
int ua_get_default_service(
ua_service_h *service);
@@ -111,7 +115,7 @@ int ua_get_default_service(
* @brief Gets service handle by service name for added service.
* @since_tizen 6.5
*
- * @remarks The @a service handle should be destroyed by using #ua_service_destroy().
+ * @remarks The @a service handle should be destroyed by using ua_service_destroy().
*
* @param[in] name The service name information
* @param[out] service The service handle
@@ -121,6 +125,7 @@ int ua_get_default_service(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter or if service with such name does not exist.
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
*/
@@ -133,7 +138,7 @@ int ua_get_service_by_name(
* @brief Creates the ua monitor's handle.
* @since_tizen 6.5
*
- * @remarks The @a monitor handle should be destroyed by using #ua_monitor_destroy().
+ * @remarks The @a monitor handle should be destroyed by using ua_monitor_destroy().
*
* @param[out] monitor The monitor handle
*
@@ -143,6 +148,7 @@ int ua_get_service_by_name(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_destroy()
*/
@@ -161,6 +167,7 @@ int ua_monitor_create(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_create()
*/
@@ -170,7 +177,7 @@ int ua_monitor_destroy(
/**
* @ingroup CAPI_NETWORK_UA_MODULE
* @brief Adds sensors to UA monitor for which monitoring is to be done.
- * Availability of sensors to be added can be checked using #ua_monitor_is_sensor_available()
+ * Availability of sensors to be added can be checked using ua_monitor_is_sensor_available()
* @since_tizen 6.5
* @remarks If you want to add the BLE sensor,
* you should add privilege %http://tizen.org/privilege/bluetooth.
@@ -189,6 +196,7 @@ int ua_monitor_destroy(
* @retval #UA_ERROR_NOT_READY Resource not ready
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_remove_sensor()
* @see ua_monitor_foreach_sensor()
@@ -218,6 +226,7 @@ int ua_monitor_add_sensor(
* @retval #UA_ERROR_NOT_READY Resource not ready
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_add_sensor()
* @see ua_monitor_foreach_sensor()
@@ -240,6 +249,7 @@ int ua_monitor_remove_sensor(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_add_sensor()
* @see ua_monitor_remove_sensor()
@@ -262,6 +272,7 @@ int ua_monitor_foreach_sensor(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_monitor_is_sensor_available(
@@ -286,6 +297,7 @@ int ua_monitor_is_sensor_available(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_monitor_set_sensor_status_changed_cb(
@@ -304,6 +316,7 @@ int ua_monitor_set_sensor_status_changed_cb(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_set_sensor_status_changed_cb()
*/
@@ -338,6 +351,7 @@ int ua_monitor_unset_sensor_status_changed_cb(
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see UA_SCAN_TIME_MULTIPLIER
* @see ua_scan_completed_cb()
@@ -369,6 +383,7 @@ int ua_monitor_start_scan(
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_scan()
*/
@@ -389,7 +404,7 @@ int ua_monitor_stop_scan(ua_monitor_h monitor);
* Therefore, the callback will be invoked when any user is detected by sensors.
*
* @param[in] monitor The monitor handle
- * @param[in] service The service handle. If service is NULL then montior will start for default service.
+ * @param[in] service The service handle. If service is NULL then monitor will start for default service.
* @param[in] mode User detection mode. \n
* #UA_DETECT_MODE_ALL_SENSORS : Detection callback will be invoked only after a user is
* detected by all sensors added to monitor. \n
@@ -406,6 +421,7 @@ int ua_monitor_stop_scan(ua_monitor_h monitor);
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_presence_detected_cb()
* @see ua_monitor_stop_presence_detection()
@@ -437,6 +453,7 @@ int ua_monitor_start_presence_detection(
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_presence_detection()
*/
@@ -458,7 +475,7 @@ int ua_monitor_stop_presence_detection(
* Therefore, the callback will be invoked only when no user is detected by sensors.
*
* @param[in] monitor The monitor handle
- * @param[in] service The service handle. If service is NULL then montior will start for default service.
+ * @param[in] service The service handle. If service is NULL then monitor will start for default service.
* @param[in] mode User detection mode. \n
* #UA_DETECT_MODE_ALL_SENSORS : Detection callback will be invoked only after no user is
* detected by all sensors added to monitor. \n
@@ -475,6 +492,7 @@ int ua_monitor_stop_presence_detection(
* @retval #UA_ERROR_NO_DATA No sensor available
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_absence_detected_cb()
* @see ua_monitor_stop_absence_detection()
@@ -506,6 +524,7 @@ int ua_monitor_start_absence_detection(
* @retval #UA_ERROR_NOT_IN_PROGRESS Operation not in progress
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_monitor_start_absence_detection()
*/
@@ -517,7 +536,7 @@ int ua_monitor_stop_absence_detection(
* @brief Creates the user handle.
* @since_tizen 6.5
*
- * @remarks The @a user handle should be destroyed by using #ua_user_destroy().
+ * @remarks The @a user handle should be destroyed by using ua_user_destroy().
*
* @param[in] account Account information. Maximum Account string
* length allowed is 254.
@@ -529,6 +548,7 @@ int ua_monitor_stop_absence_detection(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_destroy()
*/
@@ -549,6 +569,7 @@ int ua_user_create(const char *account,
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_create()
*/
@@ -569,6 +590,7 @@ int ua_user_destroy(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
* @retval #UA_ERROR_ALREADY_REGISTERED Already Registered
*
* @see ua_user_remove()
@@ -588,6 +610,7 @@ int ua_user_add(ua_user_h user);
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_add()
*/
@@ -607,6 +630,7 @@ int ua_user_remove(ua_user_h user);
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_create()
*/
@@ -632,6 +656,7 @@ int ua_user_get_account(ua_user_h user, char **account);
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_remove_device()
* @see ua_user_device_added_cb()
@@ -658,9 +683,10 @@ int ua_user_add_device(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
- * @retcal #UA_ERROR_RESOURCE_BUSY Remove done. but another service uses this device.
+ * @retval #UA_ERROR_RESOURCE_BUSY Remove done. but another service uses this device.
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_user_add_device()
*/
@@ -682,6 +708,7 @@ int ua_user_remove_device(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_registered_device_cb()
*/
@@ -695,7 +722,7 @@ int ua_user_foreach_devices(
* @brief Creates the service handle.
* @since_tizen 6.5
*
- * @remarks The @a service handle should be destroyed by using #ua_service_destroy().
+ * @remarks The @a service handle should be destroyed by using ua_service_destroy().
*
* @param[in] name The service name information
* @param[out] service The service handle
@@ -706,6 +733,7 @@ int ua_user_foreach_devices(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_destroy()
*/
@@ -727,6 +755,7 @@ int ua_service_create(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
*/
@@ -747,6 +776,7 @@ int ua_service_destroy(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_remove()
*/
@@ -768,6 +798,7 @@ int ua_service_add(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_create()
* @see ua_service_remove()
@@ -788,6 +819,7 @@ int ua_service_update(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_add()
*/
@@ -808,8 +840,9 @@ int ua_service_remove(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
- * @see ua_service_set_name()
+ * @see ua_service_create()
*/
int ua_service_get_name(
ua_service_h service,
@@ -830,6 +863,7 @@ int ua_service_get_name(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_service_set_detection_threshold(
@@ -851,6 +885,7 @@ int ua_service_set_detection_threshold(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_set_detection_threshold()
*/
@@ -866,7 +901,7 @@ int ua_service_get_detection_threshold(
*
* @remarks The @a user should not be released.
* @remarks The @a user is available until user is
- * removed and released by application using #ua_user_remove()
+ * removed and released by application using ua_user_remove()
* and ua_user_destroy()
*
* @param[in] service The service handle
@@ -877,6 +912,7 @@ int ua_service_get_detection_threshold(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_service_get_user_by_account(ua_service_h service,
@@ -895,6 +931,7 @@ int ua_service_get_user_by_account(ua_service_h service,
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_remove_user()
*/
@@ -916,6 +953,7 @@ int ua_service_add_user(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_add_user()
*/
@@ -936,6 +974,7 @@ int ua_service_remove_user(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_service_user_cb()
*/
@@ -949,7 +988,7 @@ int ua_service_foreach_users(
* @brief Creates the device handle.
* @since_tizen 6.5
*
- * @remarks The @a device handle should be destroyed using #ua_user_destroy().
+ * @remarks The @a device handle should be destroyed using ua_user_destroy().
*
* @param[in] mac_type The MAC address type of the device
* @param[in] mac_address The device's MAC address.
@@ -963,6 +1002,7 @@ int ua_service_foreach_users(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_destroy()
*/
@@ -985,6 +1025,7 @@ int ua_device_create(ua_mac_type_e mac_type,
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_create()
*/
@@ -1024,6 +1065,7 @@ int ua_device_get_mac_type(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_os_info()
*/
@@ -1103,6 +1145,7 @@ int ua_device_get_device_id(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_wifi_bssid()
*/
@@ -1143,6 +1186,7 @@ int ua_device_get_wifi_bssid(
* @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_get_wifi_ipv4_address()
*/
@@ -1200,6 +1244,7 @@ int ua_device_get_last_presence(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_create()
*/
@@ -1226,6 +1271,7 @@ int ua_device_get_pairing_required(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OPERATION_FAILED Operation failed
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
* @see ua_device_set_os_info()
* @see ua_device_set_wifi_ipv4_address()
@@ -1240,8 +1286,8 @@ int ua_device_update(
*
* @remarks The @a device handle should not be released.
* @remarks The @a device handle is available until device is
- * removed and released by application using #ua_user_remove_device()
- * and #ua_device_destroy()
+ * removed and released by application using ua_user_remove_device()
+ * and ua_device_destroy()
*
* @param[in] mac The device's MAC address
* @param[out] device The device handle
@@ -1251,6 +1297,7 @@ int ua_device_update(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_device_get_by_mac_address(
@@ -1264,8 +1311,8 @@ int ua_device_get_by_mac_address(
*
* @remarks The @a device handle should not be released.
* @remarks The @a device handle is available until device is
- * removed and released by application using #ua_user_remove_device()
- * and #ua_device_destroy()
+ * removed and released by application using ua_user_remove_device()
+ * and ua_device_destroy()
*
* @param[in] device_id The device ID
* @param[in] mac_type The device's MAC type
@@ -1276,6 +1323,7 @@ int ua_device_get_by_mac_address(
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_device_get_by_device_id(
@@ -1295,6 +1343,7 @@ int ua_device_get_by_device_id(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_status(
@@ -1313,6 +1362,7 @@ int ua_sensor_get_status(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_timestamp(
@@ -1331,6 +1381,7 @@ int ua_sensor_get_timestamp(
* @retval #UA_ERROR_NONE Successful
* @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
+ * @retval #UA_ERROR_NOT_SUPPORTED Not Supported
*
*/
int ua_sensor_get_type(