Merge "[2.2.1] Apply reviewed header file (Base to Collection)" into tizen_2.2
[platform/framework/native/appfw.git] / inc / FAppPkgIPackageUninstallationResponseListener.h
index 13a53c3..7e2afcf 100755 (executable)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -38,7 +37,10 @@ namespace Tizen { namespace App { namespace Package
  *
  * @since      2.0
  *
- * The %IPackageUninstallationResponseListener interface defines a listener for the asynchronous package uninstallation operation.
+ * 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()
  *
  */
 class _OSP_EXPORT_ IPackageUninstallationResponseListener
@@ -46,25 +48,25 @@ class _OSP_EXPORT_ IPackageUninstallationResponseListener
 {
 public:
        /**
-     * This polymorphic destructor should be overridden if required.
-     * This way, the destructors of the derived classes are called when the destructor of this interface is called.
-     *
-     * @since  2.0
-     *
-     */
+       * 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
+       *
+       */
        virtual ~IPackageUninstallationResponseListener(void) {}
 
        /**
-     * Called when a package uninstallation is completed. @n
-        * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @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
-     *
-     */
+       * Called when a package uninstallation is completed. @n
+       * 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
+       *
+       */
        virtual void OnPackageUninstallationResponseReceived(const PackageId& packageId, bool uninstallationResult) = 0;
 
 
@@ -73,7 +75,7 @@ protected:
        // This method is for internal use only.
        // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
        //
-       // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+       // This method is reserved and may change its name at any time without prior notice.
        //
        // @since       2.0
        //
@@ -83,7 +85,7 @@ protected:
        // This method is for internal use only.
        // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
        //
-       // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+       // This method is reserved and may change its name at any time without prior notice.
        //
        // @since       2.0
        //
@@ -93,7 +95,7 @@ protected:
        // This method is for internal use only.
        // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
        //
-       // The following methods are reserved and the name of the methods can be changed at any time without prior notice.
+       // This method is reserved and may change its name at any time without prior notice.
        //
        // @since       2.0
        //