From 51be9df64c710d680cf6212c0849ac90e7d76e41 Mon Sep 17 00:00:00 2001 From: Duyoung Jang Date: Thu, 24 Oct 2013 15:27:52 +0900 Subject: [PATCH] Update doxygen Change-Id: I1a6a20363c5277f8fda4dde302460be0a44a412b Signed-off-by: Duyoung Jang --- inc/FAppPkg.h | 4 +- inc/FAppPkgIPackageInstallationEventListener.h | 22 +-- inc/FAppPkgIPackageInstallationResponseListener.h | 12 +- ...FAppPkgIPackageUninstallationResponseListener.h | 12 +- inc/FAppPkgPackageAppInfo.h | 42 +++--- inc/FAppPkgPackageInfo.h | 54 +++---- inc/FAppPkgPackageManager.h | 168 +++++++++++---------- 7 files changed, 163 insertions(+), 151 deletions(-) mode change 100644 => 100755 inc/FAppPkgPackageInfo.h diff --git a/inc/FAppPkg.h b/inc/FAppPkg.h index 4c49503..e0dc1ed 100755 --- a/inc/FAppPkg.h +++ b/inc/FAppPkg.h @@ -38,9 +38,9 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * - * The %Package namespace contains classes and interfaces for information of packages and management of its installation or uninstallation. + * The %Package namespace contains classes and interfaces for obtaining the information and managing the installation or uninstallation of a package. * * The following diagram illustrates the relationships between the classes belonging to the %Package namespace. * @image html app_package_namespace_classdiagram.png diff --git a/inc/FAppPkgIPackageInstallationEventListener.h b/inc/FAppPkgIPackageInstallationEventListener.h index 96d33bb..dc55cc3 100755 --- a/inc/FAppPkgIPackageInstallationEventListener.h +++ b/inc/FAppPkgIPackageInstallationEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace App { namespace Package /** * @enum PackageInstallationResult * - * Defines the result of package installation. + * Defines the result of a package installation. * * @since 2.0 */ @@ -40,26 +40,26 @@ enum PackageInstallationResult { PACKAGE_INSTALLATION_RESULT_SUCCESS = 0, /**< Success */ PACKAGE_INSTALLATION_RESULT_INVALID_PACKAGE, /**< An invalid package */ - PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation target storage is full. */ + PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation's target storage is full */ }; /** * @interface IPackageInstallationEventListener -* @brief This interface defines a listener for a package installation and uninstallation. +* @brief This interface defines a listener for a package's installation and uninstallation. * * @since 2.0 * -* The %IPackageInstallationEventListener interface defines a listener that is notified for events related to installation or uninstallation of packages on a device. +* The %IPackageInstallationEventListener interface defines a listener that is notified about events related to the installation or uninstallation of a package on a device. * The events include installation completion, uninstallation completion, and installation progress. -* This listener is registered with the PackageManager::AddPackageInstallationEventListener() method and unregistered with the PackageManager::RemovePackageInstallationEventListener() method. -* Generally, this listener is used in system applications such as application service that utilizes packages' (un)installation information in a system. +* This listener is registered using the PackageManager::AddPackageInstallationEventListener() method and unregistered using the PackageManager::RemovePackageInstallationEventListener() method. +* Generally, this listener is used in system applications such as an application service that utilizes a package's (un)installation information that is present in the system. */ class _OSP_EXPORT_ IPackageInstallationEventListener : virtual public Tizen::Base::Runtime::IEventListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -79,13 +79,13 @@ public: /** * Called when a package uninstallation is completed. @n - * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false. + * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false. * * @since 2.0 * - * @param[in] packageId The package ID + * @param[in] packageId The package ID * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n - * else @c false + * else @c false */ virtual void OnPackageUninstallationCompleted(const PackageId& packageId, bool uninstallationResult) = 0; @@ -95,7 +95,7 @@ public: * @since 2.0 * * @param[in] packageId The package ID - * @param[in] progress The progress of an installation in percentage + * @param[in] progress The progress of the installation in percentage */ virtual void OnPackageInstallationInProgress(const PackageId& packageId, int progress) = 0; diff --git a/inc/FAppPkgIPackageInstallationResponseListener.h b/inc/FAppPkgIPackageInstallationResponseListener.h index da8e6df..b4d203c 100755 --- a/inc/FAppPkgIPackageInstallationResponseListener.h +++ b/inc/FAppPkgIPackageInstallationResponseListener.h @@ -37,9 +37,9 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageInstallationResponseListener interface defines a listener that is notified for events related to installation of a target package. - * The events include installation result and installation progress information. - * Generally, applications such as %Tizen Store use this listener in a package installation step. + * The %IPackageInstallationResponseListener interface defines a listener that is notified about events related to the installation of a target package. + * The events include the installation result and the installation progress information. + * Generally, applications such as the Tizen Store use this listener in a package installation step. * @see PackageManager::InstallPackage() */ class _OSP_EXPORT_ IPackageInstallationResponseListener @@ -47,7 +47,7 @@ class _OSP_EXPORT_ IPackageInstallationResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -61,7 +61,7 @@ public: * * @since 2.0 * - * @param[in] packageId The package ID + * @param[in] packageId The package ID * @param[in] installationResult The installation result * */ @@ -73,7 +73,7 @@ public: * @since 2.0 * * @param[in] packageId The package ID - * @param[in] progress The progress of an installation in percentage + * @param[in] progress The progress of the installation in percentage * */ virtual void OnPackageInstallationInProgressResponseReceived(const PackageId& packageId, int progress) = 0; diff --git a/inc/FAppPkgIPackageUninstallationResponseListener.h b/inc/FAppPkgIPackageUninstallationResponseListener.h index 4609804..7e2afcf 100755 --- a/inc/FAppPkgIPackageUninstallationResponseListener.h +++ b/inc/FAppPkgIPackageUninstallationResponseListener.h @@ -37,9 +37,9 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageUninstallationResponseListener interface defines a listener that is notified for events related to uninstallation of a target package. - * The events include uninstallation result. - * Generally, applications such as %Tizen Store use this listener in a package uninstallation step. + * The %IPackageUninstallationResponseListener interface defines a listener that is notified about events related to the uninstallation of a target package. + * The events include the uninstallation result. + * Generally, applications such as the %Tizen Store use this listener in a package uninstallation step. * @see PackageManager::UninstallPackage() * */ @@ -48,7 +48,7 @@ class _OSP_EXPORT_ IPackageUninstallationResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -58,13 +58,13 @@ public: /** * Called when a package uninstallation is completed. @n - * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false. + * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false. * * @since 2.0 * * @param[in] packageId The package ID * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n - * else @c false + * else @c false * */ virtual void OnPackageUninstallationResponseReceived(const PackageId& packageId, bool uninstallationResult) = 0; diff --git a/inc/FAppPkgPackageAppInfo.h b/inc/FAppPkgPackageAppInfo.h index 7604bd4..db74266 100755 --- a/inc/FAppPkgPackageAppInfo.h +++ b/inc/FAppPkgPackageAppInfo.h @@ -38,13 +38,13 @@ namespace Tizen { namespace App { namespace Package /** * @class PackageAppInfo - * @brief This class represents the information of the application in package. + * @brief This class represents the information of an application in a package. * * @since 2.0 * * @final This class is not intended for extension. * - * The %PackageAppInfo class provides the information of the application in package. + * The %PackageAppInfo class provides the information of an application in a package. * */ class _OSP_EXPORT_ PackageAppInfo @@ -59,11 +59,11 @@ public: virtual ~PackageAppInfo(void); /** - * Gets an application ID. + * Gets the application ID. * * @since 2.0 * - * @return An application ID + * @return The application ID */ AppId GetAppId(void) const; @@ -72,7 +72,7 @@ public: * * @since 2.0 * - * @return The name of an application + * @return The name of the application */ Tizen::Base::String GetAppName(void) const; @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return The display name of an application + * @return The display name of the application */ Tizen::Base::String GetAppDisplayName(void) const; @@ -90,7 +90,7 @@ public: * * @since 2.1 * - * @return The menu icon path of an application, @n + * @return The menu icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppMenuIconPath(void) const; @@ -100,8 +100,8 @@ public: * * @since 2.1 * - * @return The setting icon path of an application, @n - * else an empty string is returned if there is no value + * @return The setting icon path of the application, @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppSettingIconPath(void) const; @@ -110,7 +110,7 @@ public: * * @since 2.1 * - * @return The notification icon path of an application, @n + * @return The notification icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppNotificationIconPath(void) const; @@ -118,10 +118,10 @@ public: /** * Gets the menu icon of an application. * - * @since 2.1 + * @since 2.1 * - * @return A pointer to the menu icon of an application, @n - * else @c null if it fails + * @return A pointer to the menu icon of the application, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The menu icon does not exist. * @exception E_UNSUPPORTED_FORMAT The image file format is not supported. @@ -134,13 +134,13 @@ public: * * @since 2.1 * - * @return A pointer to a map of key(Tizen::Base::String) and value(Tizen::Base::String) pairs of the metadata, @n + * @return A pointer to the map of the key(Tizen::Base::String) and value(%Tizen::Base::String) pairs of the metadata, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks - * - The specific error code can be accessed using the GetLastResult() method. - * - Application can use the metadata to set app-wide information. + * - The specific error code can be accessed using the GetLastResult() method. + * - An application can use the metadata to set the app-wide information. */ Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const; @@ -158,22 +158,22 @@ public: Tizen::Base::Collection::IList* GetAppCategoryListN(void) const; /** - * Checks whether an application is visible on the menu. + * Checks if an application is visible on the menu. * * @since 2.0 * - * @return @c true if an application is visible on the menu, @n + * @return @c true if the application is visible on the menu, @n * else @c false - * @remarks If the return value is @c false, it is recommended not to display the application on the menu. + * @remarks If the return value is @c false, it is not recommended to display the application on the menu. */ bool IsMenuIconVisible(void) const; /** - * Checks whether an application is the main application of the package. + * Checks if an application is the main application of the package. * * @since 2.0 * - * @return @c true if an application is the main application of the package, @n + * @return @c true if the application is the main application of the package, @n * else @c false */ bool IsMainApp(void) const; diff --git a/inc/FAppPkgPackageInfo.h b/inc/FAppPkgPackageInfo.h old mode 100644 new mode 100755 index 65dc94d..42a11c8 --- a/inc/FAppPkgPackageInfo.h +++ b/inc/FAppPkgPackageInfo.h @@ -54,11 +54,11 @@ public: virtual ~PackageInfo(void); /** - * Gets a package ID. + * Gets the package ID. * * @since 2.0 * - * @return A package ID + * @return The package ID */ PackageId GetId(void) const; @@ -67,7 +67,7 @@ public: * * @since 2.0 * - * @return The version of a package + * @return The version of the package */ Tizen::Base::String GetVersion(void) const; @@ -76,7 +76,7 @@ public: * * @since 2.0 * - * @return The display name of a package + * @return The display name of the package */ Tizen::Base::String GetDisplayName(void) const; @@ -85,7 +85,7 @@ public: * * @since 2.0 * - * @return The description of a package, @n + * @return The description of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetDescription(void) const; @@ -95,7 +95,7 @@ public: * * @since 2.0 * - * @return The author of a package, @n + * @return The author of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAuthor(void) const; @@ -105,56 +105,56 @@ public: * * @since 2.0 * - * @return The URL of a package, @n + * @return The URL of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetUrl(void) const; /** - * Gets the date and time when a package is installed. + * Gets the date and the time when a package is installed. * * @since 2.0 * - * @return An instance of Tizen::Base::DateTime when a package is installed + * @return An instance of Tizen::Base::DateTime which contains the package installation details */ Tizen::Base::DateTime GetInstallationTime(void) const; /** - * Checks whether a package is installed in the external storage. + * Checks if a package is installed in the external storage. * * @since 2.0 * - * @return @c true if a package is installed in the external storage, @n + * @return @c true if the package is installed in the external storage, @n * else @c false */ bool IsInstalledInExternalStorage(void) const; /** - * Checks whether it is possible to uninstall a package. + * Checks if it is possible to uninstall a package. * * @since 2.0 * - * @return @c true if it is possible to uninstall a package, @n + * @return @c true if it is possible to uninstall the package, @n * else @c false */ bool IsUninstallable(void) const; /** - * Checks whether it is possible to move a package to either internal or external storage. + * Checks if it is possible to move a package to either the internal or the external storage. * * @since 2.0 * - * @return @c true if it is possible to move a package to either internal or external storage, @n + * @return @c true if it is possible to move the package to either the internal or the external storage, @n * else @c false */ bool IsMovable(void) const; /** - * Checks whether a package is downloaded. + * Checks if a package is downloaded. * * @since 2.0 * - * @return @c true if a package is downloaded, @n + * @return @c true if the package is downloaded, @n * else @c false */ bool IsDownloaded(void) const; @@ -164,7 +164,7 @@ public: * * @since 2.0 * - * @return The size of a package + * @return The size of the package */ long long GetSize(void) const; @@ -173,7 +173,7 @@ public: * * @since 2.0 * - * @return The data size of a package + * @return The data size of the package */ long long GetDataSize(void) const; @@ -212,11 +212,11 @@ public: * * @since 2.0 * - * @return A pointer to PackageAppInfo + * @return A pointer to the PackageAppInfo instance * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OBJ_NOT_FOUND The application information is not found. + * @exception E_OBJ_NOT_FOUND The application information has not been found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -225,12 +225,12 @@ public: /** * Gets the type of a package. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * - * @return The package type + * @return The package type */ PackageType GetType(void) const; @@ -239,10 +239,10 @@ public: * * @since 2.1 * - * @return A pointer to the list of Tizen::Security::PrivilegeInfo instances, @n + * @return A pointer to the list of the Tizen::Security::PrivilegeInfo instances, @n * else @c null if it fails - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPrivilegeListN(void) const; diff --git a/inc/FAppPkgPackageManager.h b/inc/FAppPkgPackageManager.h index 59d24a2..ee3ce3e 100755 --- a/inc/FAppPkgPackageManager.h +++ b/inc/FAppPkgPackageManager.h @@ -45,20 +45,20 @@ class IPackageUninstallationResponseListener; */ enum PackageType { - PACKAGE_TYPE_TPK, /**< TIZEN Native package */ - PACKAGE_TYPE_WGT, /**< TIZEN %Web package */ - PACKAGE_TYPE_RPM, /**< TIZEN Core package */ + PACKAGE_TYPE_TPK, /**< %Tizen native package */ + PACKAGE_TYPE_WGT, /**< %Tizen Web package */ + PACKAGE_TYPE_RPM, /**< %Tizen Core package */ }; /** * @class PackageManager - * @brief This class gets the information of packages and manages package installation or uninstallation. + * @brief This class gets the information of a package and manages the package's installation or uninstallation. * * @since 2.0 * * @final This class is not intended for extension. * - * The %PackageManager class provides methods to install or uninstall the packages, retrieves the information of the packages that are installed on the device. + * The %PackageManager class provides methods to install or uninstall a package and retrieve the information of a package that is installed on the device. * * For more information on the class features, see Package Management. * @@ -73,7 +73,8 @@ public: * @since 2.0 * * @return The package ID, @n - * else @c packageId.IsEmtpy() == true is returned if an error occurs + * else an empty package ID if an error occurs @n + * Checks with packageId.IsEmpty() whether the package ID is empty. * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -84,10 +85,10 @@ public: /** * Adds a package installation event listener. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return An error code * @param[in] listener The package installation event listener @@ -103,31 +104,33 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return An error code * @param[in] listener The package installation event listener * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not added or is already removed. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The listener is not added. + * - The listener is already removed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result RemovePackageInstallationEventListener(IPackageInstallationEventListener& listener); /** - * Gets a package information with the specific package ID. + * Gets the package information with the specific package ID. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return A pointer to PackageInfo + * @return A pointer to the PackageInfo instance * @param[in] packageId The package ID - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PKG_NOT_INSTALLED The package is not installed. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ PackageInfo* GetPackageInfoN(const PackageId& packageId) const; @@ -138,9 +141,9 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return A pointer to PackageAppInfo + * @return A pointer to the PackageAppInfo instance * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -156,7 +159,7 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return A pointer to the list of the PackageInfo instances, @n * else @c null if it fails @@ -173,11 +176,11 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return @c true if a package is installed, @n - * else @c false - * @param[in] packageId The package ID + * @return @c true if the package is installed, @n + * else @c false + * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -188,7 +191,8 @@ public: /** * Installs a package. @n - * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response. The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS. + * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response. + * The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS. * * @since 2.0 * @privlevel platform @@ -202,13 +206,17 @@ public: * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed. + * @remarks + * - A listener instance ownership is transferred to the platform. + * - After notifying the result, the listener instance is removed automatically. + * - A reuse of the listener instance is not allowed. */ result InstallPackage(const PackageId& packageId, const Tizen::Base::String& packagePath, IPackageInstallationResponseListener* pListener); /** * Uninstalls a package with the specified package ID. @n - * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response. The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true. + * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response. + * The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true. * * @since 2.0 * @privlevel platform @@ -220,74 +228,78 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed. + * @remarks + * - A listener instance ownership is transferred to the platform. + * - After notifying the result, the listener instance is removed automatically. + * - A reuse of the listener instance is not allowed. */ result UninstallPackage(const PackageId& packageId, IPackageUninstallationResponseListener* pListener); /** - * Moves a package with the specified package ID to an external storage. + * Moves a package with the specified package ID to the external storage. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * * @return An error code * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_OPERATION The package is already installed in an external storage. + * @exception E_INVALID_OPERATION The package is already installed in the external storage. * @exception E_STORAGE_FULL The storage is full. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result MoveToExternalStorage(const PackageId& packageId); /** - * Moves a package with the specified package ID to an internal storage. + * Moves a package with the specified package ID to the internal storage. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * * @return An error code * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_OPERATION The package is already installed in an internal storage. + * @exception E_INVALID_OPERATION The package is already installed in the internal storage. * @exception E_STORAGE_FULL The storage is full. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result MoveToInternalStorage(const PackageId& packageId); /** - * Gets a package information from a specific file. @n The supported file extensions are tpk and wgt. + * Gets the package information from a specific file. @n + * The supported file extensions are tpk and wgt. * * @since 2.1 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.info * * @return A pointer to the PackageInfo instance, @n - * else @c null if it fails - * @param[in] filePath The package file path - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. - * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported. - * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if it fails + * @param[in] filePath The package file path + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. + * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported. + * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ PackageInfo* GetPackageInfoFromFileN(const Tizen::Base::String& filePath) const; /** - * Gets the package information list with the package filter. + * Gets the package information list using the package filter. * * @since 2.1 * @privlevel public @@ -296,18 +308,18 @@ public: * @return A pointer to the list of the PackageInfo instances, @n * else @c null if it fails * @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n - * For more information on the predefined key-value pairs for package filter, - * see the predefined key-value pairs for package filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * For more information on the predefined key-value pairs for the package filter, + * see the predefined key-value pairs for the package filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap) const; /** - * Gets the application information list with the package app filter. + * Gets the application information list using the package application filter. * * @since 2.1 * @privlevel public @@ -315,47 +327,47 @@ public: * * @return A pointer to the list of the PackageAppInfo instances, @n * else @c null if it fails - * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n - * For more information, see - * the predefined key-value pairs for package app filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n + * For more information, see + * the predefined key-value pairs for the package application filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageAppFilterMap) const; /** - * Gets the application information list with the package filter and package app filter. + * Gets the application information list using the package filter and the package application filter. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/package.info * * @return A pointer to the list of the PackageAppInfo instances, @n - * else @c null if it fails + * else @c null if it fails * @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n - * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n - * The user defined key-value pairs can be added in of manifest.xml. @n For more information, - * see the predefined key-value pairs - * for package filter and the - * predefined key-value pairs for package app filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(%Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n + * The user defined key-value pairs can be added in the of the manifest.xml. @n For more information, + * see the predefined key-value pairs + * for the package filter, and the + * predefined key-value pairs for the package application filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap, const Tizen::Base::Collection::IMap& packageAppFilterMap) const; /** - * Gets the package manager instance. + * Gets a pointer to the %PackageManager instance. * * @since 2.0 * * @return A pointer to the %PackageManager instance, @n - * else @c null + * else @c null if it fails * @remarks The specific error code can be accessed using the GetLastResult() method. */ static PackageManager* GetInstance(void); -- 2.7.4