Add missing retval for preference
authorMyungki Lee <mk5004.lee@samsung.com>
Mon, 13 Jun 2016 10:14:20 +0000 (19:14 +0900)
committerMyungki Lee <mk5004.lee@samsung.com>
Mon, 13 Jun 2016 10:14:20 +0000 (19:14 +0900)
Change-Id: I024483c7c9bd6edc46cac818348623b8fcee2df2
Signed-off-by: Myungki Lee <mk5004.lee@samsung.com>
include/app_preference.h

index fb37afd..6313ffa 100644 (file)
@@ -93,6 +93,7 @@ typedef bool (*preference_item_cb)(const char *key, void *user_data);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_get_int()
  */
@@ -109,6 +110,7 @@ int preference_set_int(const char *key, int value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_NO_KEY    Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_set_int()
@@ -126,6 +128,7 @@ int preference_get_int(const char *key, int *value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE      Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_get_double()
  */
@@ -142,6 +145,7 @@ int preference_set_double(const char *key, double value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE      Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_NO_KEY    Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_set_double()
@@ -161,6 +165,7 @@ int preference_get_double(const char *key, double *value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE      Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_get_string()
  */
@@ -196,6 +201,7 @@ int preference_get_string(const char *key, char **value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE      Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_get_boolean()
  */
@@ -212,6 +218,7 @@ int preference_set_boolean(const char *key, bool value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE      Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_NO_KEY    Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_set_boolean()
@@ -228,6 +235,8 @@ int preference_get_boolean(const char *key, bool *value);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #PREFERENCE_ERROR_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  */
 int preference_remove(const char *key);
@@ -244,6 +253,7 @@ int preference_remove(const char *key);
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  */
 int preference_is_existing(const char *key, bool *existing);
@@ -256,6 +266,7 @@ int preference_is_existing(const char *key, bool *existing);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_remove()
  */
@@ -292,6 +303,8 @@ int preference_set_changed_cb(const char *key, preference_changed_cb callback, v
  *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #PREFERENCE_ERROR_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
  * @see        preference_set_changed_cb()
  */