From 5a4b3f2eb54b8fe4717ef0cc6a83a04ba181ff16 Mon Sep 17 00:00:00 2001
From: shilei <shilei91@huawei.com>
Date: Fri, 18 Sep 2020 10:53:42 +0800
Subject: [PATCH] =?UTF-8?q?update=20install=5Fparam.h.=20=E5=B0=86install?=
 =?UTF-8?q?=5Fparam.h=E9=87=8C=E9=9D=A2=E7=9A=84=E5=B8=B8=E9=87=8F?=
 =?UTF-8?q?=E6=94=B9=E6=88=90=E6=9E=9A=E4=B8=BE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 install_param.h | 49 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 44 insertions(+), 5 deletions(-)

diff --git a/install_param.h b/install_param.h
index d9f8cf3..2a18c47 100755
--- a/install_param.h
+++ b/install_param.h
@@ -13,6 +13,32 @@
  * limitations under the License.
  */
 
+/**
+ * @addtogroup BundleManager
+ * @{
+ *
+ * @brief Provides structures and functions for managing application bundles and obtaining application information.
+ *
+ * You can use functions provided by this module to install, update, or uninstall an application, obtain
+ * {@link AbilityInfo} and {@link BundleInfo} about an application, and obtain the bundle name of an application
+ * based on the application's user ID (UID).
+ *
+ * @since 1.0
+ * @version 1.0
+ */
+
+/**
+ * @file installParam.h
+ *
+ * @brief Declares the parameters that users can specify when they install, update, or uninstall an application.
+ *
+ * The parameters involve the application installation or update path and whether to retain particular data during
+ * application uninstallation.
+ *
+ * @since 1.0
+ * @version 1.0
+ */
+
 #ifndef OHOS_INSTALL_PARAM_H
 #define OHOS_INSTALL_PARAM_H
 
@@ -20,14 +46,27 @@
 
 #include <stdbool.h>
 
-// when installLocation set 1, it means install dir is storage/app
-const static int32_t INSTALL_LOCATION_INTERNAL_ONLY = 1;
-// when installLocation set 2, it means install dir is sdcard/app
-const static int32_t INSTALL_LOCATION_PREFER_EXTERNAL = 2;
+enum InstallLocation {
+/**
+ * The installation or update path is <b>storage/app</b> when {@link installLocation} is set to <b>1</b>.
+ */
+    INSTALL_LOCATION_INTERNAL_ONLY = 1,
+/**
+ * The installation or update path is <b>sdcard/app</b> when {@link installLocation} is set to <b>2</b>.
+ */
+    INSTALL_LOCATION_PREFER_EXTERNAL = 2,
+};
 
+/**
+* @brief Defines parameters used for application installation, update, or uninstallation.
+*/
 typedef struct {
+    /** Installation or update path of the application */
     int32_t installLocation;
+
+    /** Whether to retain particular data during application uninstallation */
     bool keepData;
 } InstallParam;
 
-#endif // OHOS_INSTALL_PARAM_H
\ No newline at end of file
+#endif // OHOS_INSTALL_PARAM_H
+/** @} */
\ No newline at end of file
-- 
Gitee