Add and modify remarks for initialize and deinitialize function 75/50575/2
authorpr.jung <pr.jung@samsung.com>
Thu, 24 Sep 2015 01:51:47 +0000 (10:51 +0900)
committerTaeyoung Kim <ty317.kim@samsung.com>
Thu, 12 Nov 2015 05:36:37 +0000 (21:36 -0800)
Change-Id: Ia013ce6db413452e1c1a94048b2af1a22305ff98
Signed-off-by: pr.jung <pr.jung@samsung.com>
include/feedback.h

index 4a74f01..7894597 100644 (file)
@@ -58,6 +58,9 @@ typedef enum
  *
  * @remarks
  * If this function is not called in advance, other function will return #FEEDBACK_ERROR_NOT_INITIALIZED.
+ * And for controlling haptic device, the privilege should be set to, %http://tizen.org/privilege/haptic.
+ * If you don't have the haptic privilege, this function initializes only sound.
+ * It does not return any error in this case.
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #FEEDBACK_ERROR_NONE               Successful
@@ -74,6 +77,12 @@ int feedback_initialize(void);
  *
  * @since_tizen 2.4
  *
+ * @remarks
+ * If you don't want to use feedback anymore, you need to deinitialize with this function.
+ * And for controlling haptic device, the privilege should be set to, %http://tizen.org/privilege/haptic.
+ * If you don't have the haptic privilege, this function deinitializes only sound.
+ * It does not return any error in this case.
+ *
  * @return 0 on success, otherwise a negative error value.
  * @retval #FEEDBACK_ERROR_NONE                 Successful
  * @retval #FEEDBACK_ERROR_NOT_INITIALIZED      Not initialized