From: Antoni <a.adaszkiewi@samsung.com>
Date: Fri, 17 May 2024 15:08:24 +0000 (+0200)
Subject: Minor changes to update-control API header documentation
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e690f45b4c7a9fdceac02a8107f5569cc9049c9b;p=platform%2Fcore%2Fsystem%2Fupdate-control.git

Minor changes to update-control API header documentation

This is neccessary for the ACR process. The name of one error code had
to be changed as well (only non-documentation change in this commit).

Change-Id: I669ac4ac6ca58935d68dcd63c4485616b83e8487
---

diff --git a/include/update_control.h b/include/update_control.h
index 16b17bc..bab3d3e 100644
--- a/include/update_control.h
+++ b/include/update_control.h
@@ -40,7 +40,7 @@ typedef enum {
 	UPDATE_CONTROL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
 	UPDATE_CONTROL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
 	UPDATE_CONTROL_ERROR_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on device */
-	UPDATE_CONTROL_ERROR_KEY_NOT_FOUND = TIZEN_ERROR_KEY_NOT_AVAILABLE, /**< Specified key is not found */
+	UPDATE_CONTROL_ERROR_KEY_NOT_AVAILABLE = TIZEN_ERROR_KEY_NOT_AVAILABLE, /**< Specified key is not available */
 	UPDATE_CONTROL_ERROR_KEY_REJECTED = TIZEN_ERROR_KEY_REJECTED, /**< Key is not available */
 	UPDATE_CONTROL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
 	UPDATE_CONTROL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
@@ -111,10 +111,10 @@ typedef void (*update_control_cb) (const update_control_error_e result, const vo
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @see update_control_deinitialize()
  */
 int update_control_initialize(void);
@@ -127,10 +127,10 @@ int update_control_initialize(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @see update_control_initialize()
  */
 int update_control_deinitialize(void);
@@ -143,10 +143,10 @@ int update_control_deinitialize(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_CONNECTION_REFUSED Connection refused
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_check_new_version(void);
 
@@ -158,6 +158,7 @@ int update_control_check_new_version(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_FILE_NO_SPACE_ON_DEVICE No space left on device
  * @retval #UPDATE_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #UPDATE_CONTROL_ERROR_CONNECTION_REFUSED Connection refused
@@ -166,7 +167,6 @@ int update_control_check_new_version(void);
  * @retval #UPDATE_CONTROL_ERROR_INVALID_URI Invalid URI
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_download_package(void);
 
@@ -181,13 +181,13 @@ int update_control_download_package(void);
  * @return @c 0 if RO update and finish were triggered successfully (doesn't guarantee upgrade script COMPLETED successfully),
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_PERMISSION_DENIED Permission denied
  * @retval #UPDATE_CONTROL_ERROR_TIMED_OUT Time out
  * @retval #UPDATE_CONTROL_ERROR_INVALID_PACKAGE Invalid package
  * @retval #UPDATE_CONTROL_ERROR_PACKAGE_NOT_SUPPORTED Package type not supported
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_do_update(void);
 
@@ -345,11 +345,11 @@ int update_control_do_finish_update_async(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
- * @retval #UPDATE_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #UPDATE_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_make_reservation(struct tm *reservation_time);
 
@@ -364,10 +364,10 @@ int update_control_make_reservation(struct tm *reservation_time);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_PERMISSION_DENIED Permission denied
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_cancel_reservation(void);
 
@@ -382,13 +382,13 @@ int update_control_cancel_reservation(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #UPDATE_CONTROL_ERROR_NONE Successful
+ * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  * @retval #UPDATE_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #UPDATE_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #UPDATE_CONTROL_ERROR_KEY_NOT_FOUND Specified property not found
+ * @retval #UPDATE_CONTROL_ERROR_KEY_NOT_AVAILABLE Specified property not found
  * @retval #UPDATE_CONTROL_ERROR_KEY_REJECTED Specified property not available
  * @retval #UPDATE_CONTROL_ERROR_SYSTEM_ERROR System error
  * @retval #UPDATE_CONTROL_ERROR_INVALID_OPERATION Function not implemented
- * @retval #UPDATE_CONTROL_ERROR_NOT_SUPPORTED Not supported
  */
 int update_control_get_property(update_control_property_e property, void **value);