From 4753f3b4997d2ed8bb29b8dafefa1b0fde13468f Mon Sep 17 00:00:00 2001
From: Neil Chen <jingsi.chen@petalmail.com>
Date: Wed, 20 Jul 2022 00:08:37 +0800
Subject: [PATCH] update comments for hals

Signed-off-by: Neil Chen <jingsi.chen@petalmail.com>
---
 hals/hal_hota_board.h | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/hals/hal_hota_board.h b/hals/hal_hota_board.h
index 1b47353..91a0766 100644
--- a/hals/hal_hota_board.h
+++ b/hals/hal_hota_board.h
@@ -29,6 +29,9 @@ extern "C" {
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalInit(void);
 
@@ -37,6 +40,9 @@ int HotaHalInit(void);
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalDeInit(void);
 
@@ -45,6 +51,9 @@ int HotaHalDeInit(void);
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalGetUpdateIndex(unsigned int *index);
 
@@ -58,6 +67,9 @@ int HotaHalGetUpdateIndex(unsigned int *index);
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalWrite(int partition, unsigned char *buffer, unsigned int offset, unsigned int bufLen);
 
@@ -71,6 +83,9 @@ int HotaHalWrite(int partition, unsigned char *buffer, unsigned int offset, unsi
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalRead(int partition, unsigned int offset, unsigned int bufLen, unsigned char *buffer);
 
@@ -79,6 +94,9 @@ int HotaHalRead(int partition, unsigned int offset, unsigned int bufLen, unsigne
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalSetBootSettings(void);
 
@@ -87,6 +105,9 @@ int HotaHalSetBootSettings(void);
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalRestart(void);
 
@@ -95,6 +116,9 @@ int HotaHalRestart(void);
  *
  * @return OHOS_SUCCESS: Success,
  *         Others: Failure.
+ *
+ * @since 1.0
+ * @version 1.0
  */
 int HotaHalRollback(void);
 
@@ -140,7 +164,7 @@ int HotaHalGetUpdateAbility(void);
  * @brief get ota package update path.
  *
  * You need to call this function before update process. \n
- * 
+ *
  * @param path Indicates where ota package you place.
  * @param len Indicates  path len.
  *