Fix some doxygen comments
[platform/core/api/package-manager.git] / include / package_info.h
index ebbe9ab..1280fca 100644 (file)
@@ -53,6 +53,7 @@ typedef struct package_updateinfo_s *package_updateinfo_h;
 typedef enum {
        PACKAGE_INFO_INTERNAL_STORAGE = 0,    /**< Internal storage */
        PACKAGE_INFO_EXTERNAL_STORAGE = 1,    /**< External storage */
+       PACKAGE_INFO_EXTENDED_STORAGE = 2,    /**< Extended storage (Since 5.0) */
 } package_info_installed_storage_type_e;
 
 
@@ -64,6 +65,8 @@ typedef enum {
        PACKAGE_INFO_ALLAPP = 0,        /**< All application */
        PACKAGE_INFO_UIAPP = 1,         /**< UI application */
        PACKAGE_INFO_SERVICEAPP = 2,    /**< Service application */
+       PACKAGE_INFO_WIDGETAPP = 3,     /**< Widget application (Since 4.0) */
+       PACKAGE_INFO_WATCHAPP = 4,      /**< Watch application (Since 4.0) */
 } package_info_app_component_type_e;
 
 
@@ -109,8 +112,8 @@ typedef bool (*package_info_updateinfo_cb) (package_updateinfo_h info, void *use
 /**
  * @brief Called to get the application ID once for each installed package.
  * @since_tizen 2.3
- * @param[in] comp_type The Application Component type
- * @param[in] callback  The callback function to be invoked
+ * @param[in] comp_type The application component type
+ * @param[in] app_id    The application ID.
  * @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
@@ -123,7 +126,7 @@ typedef bool (*package_info_app_cb) (package_info_app_component_type_e comp_type
 /**
  * @brief Called to get the certification information.
  * @since_tizen 2.3
- * @param[in] package_info The package info handle
+ * @param[in] handle       The package info handle
  * @param[in] cert_type    The certificate type
  * @param[in] cert_value   The certificate value of corresponding certificate key \n
  *                         This value is base64 encoded data.
@@ -307,7 +310,7 @@ int package_info_get_root_path(package_info_h package_info, char **path);
 
 /**
  * @platform
- * @brief Gets the name of the TEP(Tizen Expansion Package).
+ * @brief Gets the name of the TEP (Tizen Expansion Package).
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/packagemanager.admin
@@ -431,7 +434,7 @@ int package_info_get_installed_time(package_info_h package_info, int *installed_
 int package_info_clone(package_info_h *clone, package_info_h package_info);
 
 /**
- * @brief Gets the package information for the given package
+ * @brief Gets the package information for the given package.
  * @since_tizen 2.3
  * @remarks You must release @a package_info using package_info_destroy().
  * @param[in]  package      The ID of the package
@@ -505,7 +508,7 @@ int package_info_updateinfo_create(const char *pkgid, package_updateinfo_h *info
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PACKAGE_MANAGER_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_pkgid(package_updateinfo_h info, char **package);
 
@@ -520,7 +523,7 @@ int package_info_updateinfo_get_pkgid(package_updateinfo_h info, char **package)
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PACKAGE_MANAGER_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_version(package_updateinfo_h info, char **version);
 
@@ -533,7 +536,7 @@ int package_info_updateinfo_get_version(package_updateinfo_h info, char **versio
  *         otherwise a negative error value
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_type(package_updateinfo_h info,
                                                package_updateinfo_type_e *type);
@@ -551,7 +554,7 @@ int package_info_updateinfo_get_type(package_updateinfo_h info,
 int package_info_updateinfo_destroy(package_updateinfo_h info);
 
 /**
- * @brief Retrieve update information of all packages and invoke callback for each of it.
+ * @brief Retrieves update information of all packages and invoke callback for each of it.
  * @since_tizen 4.0
  * @param[in] callback     The iteration callback function
  * @param[in] user_data    The user data to be passed to the callback function