Update doxygen

Change-Id: I893ad240b7ad3e8dd8c39e202e4c338796bcfb73
Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>

diff --git a/include/app_preference.h b/include/app_preference.h
index 4be83969d0d6d17745eca545d07078bba50688db..7113578fe8db6d2243b86e4f3c2642609f7e2408 100644 (file)
--- a/include/app_preference.h
+++ b/include/app_preference.h
@@ -57,7 +57,7 @@ typedef enum {
  * @pre This function is invoked when the value of the key is overwritten after you register this callback using preference_set_changed_cb().
  * @see preference_set_changed_cb()
  * @see preference_unset_changed_cb()
- * @see        preference_set_boolean()
+ * @see preference_set_boolean()
  * @see preference_set_int()
  * @see preference_set_string()
  * @see preference_set_double()
@@ -73,8 +73,8 @@ typedef void (*preference_changed_cb) (const char *key, void *user_data);
  * @param[in] user_data The user data passed from the foreach function
  * @return @c true to continue with the next iteration of the loop,
  *         otherwise @c false to break out of the loop
- * @pre        preference_foreach_item() will invoke this callback function.
- * @see        preference_foreach_item()
+ * @pre preference_foreach_item() will invoke this callback function.
+ * @see preference_foreach_item()
  */
 typedef bool (*preference_item_cb)(const char *key, void *user_data);
 
@@ -85,12 +85,12 @@ typedef bool (*preference_item_cb)(const char *key, void *user_data);
  * @param[in] key The name of the key to modify
  * @param[in] value  The new @c int value for the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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_OUT_OF_MEMORY Out of memory
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
- * @see        preference_get_int()
+ * @see preference_get_int()
  */
 int preference_set_int(const char *key, int value);
 
@@ -101,13 +101,13 @@ int preference_set_int(const char *key, int value);
  * @param[in] key The name of the key to retrieve
  * @param[out] value The @c int value for the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
- * @see        preference_set_int()
+ * @see preference_set_int()
  */
 int preference_get_int(const char *key, int *value);
 
@@ -118,12 +118,12 @@ int preference_get_int(const char *key, int *value);
  * @param[in] key The name of the key to modify
  * @param[in] value  The new @c double value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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()
+ * @see preference_get_double()
  */
 int preference_set_double(const char *key, double value);
 
@@ -134,13 +134,13 @@ int preference_set_double(const char *key, double value);
  * @param[in] key The name of the key to retrieve
  * @param[out] value The @c double value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
- * @see        preference_set_double()
+ * @see preference_set_double()
  */
 int preference_get_double(const char *key, double *value);
 
@@ -152,12 +152,12 @@ int preference_get_double(const char *key, double *value);
  * @param[in] key The name of the key to modify
  * @param[in] value The new @c string value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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()
+ * @see preference_get_string()
  */
 int preference_set_string(const char *key, const char *value);
 
@@ -169,13 +169,13 @@ int preference_set_string(const char *key, const char *value);
  * @param[in] key The name of the key to retrieve
  * @param[out] value The @c string value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
- * @see        preference_set_string()
+ * @see preference_set_string()
  */
 int preference_get_string(const char *key, char **value);
 
@@ -186,12 +186,12 @@ int preference_get_string(const char *key, char **value);
  * @param[in] key The name of the key to modify
  * @param[in] value The new @c boolean value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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()
+ * @see preference_get_boolean()
  */
 int preference_set_boolean(const char *key, bool value);
 
@@ -202,13 +202,13 @@ int preference_set_boolean(const char *key, bool value);
  * @param[in] key The name of the key to retrieve
  * @param[out] value The @c boolean value associated with the given key
  * @return @c 0 on success,
- *                     otherwise a negative error 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_NO_KEY Required key not available
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error
- * @see        preference_set_boolean()
+ * @see preference_set_boolean()
  */
 int preference_get_boolean(const char *key, bool *value);
 
@@ -218,7 +218,7 @@ int preference_get_boolean(const char *key, bool *value);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] key The name of the key to remove
  * @return @c 0 on success,
- *                     otherwise a negative error 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
@@ -235,7 +235,7 @@ int preference_remove(const char *key);
  * @param[out] existing If @c true the @a key exists in the preference,
  *                         otherwise @c false
  * @return @c 0 on success,
- *                     otherwise a negative error 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
@@ -248,11 +248,11 @@ int preference_is_existing(const char *key, bool *existing);
  * @brief Removes all key-value pairs from the preference.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @return @c 0 on success,
- *                     otherwise a negative error value
+ *         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()
+ * @see preference_remove()
  */
 int preference_remove_all(void);
 
@@ -264,14 +264,14 @@ int preference_remove_all(void);
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
  * @return @c 0 on success,
- *                     otherwise a negative error 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
  * @post preference_changed_cb() will be invoked.
- * @see        preference_unset_changed_cb()
+ * @see preference_unset_changed_cb()
  * @see preference_changed_cb()
  */
 int preference_set_changed_cb(const char *key, preference_changed_cb callback, void *user_data);
@@ -282,13 +282,13 @@ int preference_set_changed_cb(const char *key, preference_changed_cb callback, v
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] key The name of the key to monitor
  * @return @c 0 on success,
- *                     otherwise a negative error 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_changed_cb()
+ * @see preference_set_changed_cb()
  */
 int preference_unset_changed_cb(const char *key);
 
@@ -299,7 +299,7 @@ int preference_unset_changed_cb(const char *key);
  * @param[in] callback The callback function to get key value once for each key-value pair in the preference
  * @param[in] user_data The user data to be passed to the callback function
  * @return @c 0 on success,
- *                     otherwise a negative error value
+ *         otherwise a negative error value
  * @retval #PREFERENCE_ERROR_NONE Successful
  * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error