Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FAppIAppControlResponseListener.h
index 61c613f..57174e2 100644 (file)
@@ -15,8 +15,8 @@
 //
 
 /**
- * @file                       FAppIAppControlResponseListener.h
- * @brief                      This is the header file for the %IAppControlResponseListener interface.
+ * @file       FAppIAppControlResponseListener.h
+ * @brief      This is the header file for the %IAppControlResponseListener interface.
  *
  * This header file contains the declarations of the %IAppControlResponseListener interface.
  */
@@ -49,7 +49,7 @@ class _OSP_EXPORT_ IAppControlResponseListener
 {
 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
@@ -57,37 +57,36 @@ public:
        virtual ~IAppControlResponseListener(void) {}
 
        /**
-        * Called when the response for application control completion is received.
+        * Called when the response for an application control completion is received.
         *
         * @since       2.0
         *
-        * @param[in]   appId                   The ID of the requested application
-        * @param[in]   operationId             The operation ID used in application control invocation
+        * @param[in]   appId                           The ID of the requested application
+        * @param[in]   operationId                     The operation ID used in the application control invocation
         * @param[in]   appControlResult        The application control result
-        * @param[in]   pExtraData              A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of 
-        *                                                      type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String
+        * @param[in]   pExtraData                      A pointer to the result map of the key and value pair, where the key is of type Tizen::Base::String and the value is of
+        *                                                                      type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
         * @remarks     The application control completion result is received when the requested application control
-        *                      sends the result using AppControlProviderManager::SendAppControlResult().
+        *                      sends the result using the AppControlProviderManager::SendAppControlResult() method.
         * @see         AppControl
         */
        virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0;
 
        /**
-        * Called when the application control is about to start or to be canceled by the user resolution. @n
+        * Called when the application control is about to start or is to be cancelled by the user resolution. @n
         * The calling application can get the result of the resolution by implementing this empty body method.
         *
         * @since       2.0
         *
-        * @param[in]   appId                   The ID of the requested application
-        * @param[in]   operationId             The operation ID used in application control invocation
-        * @param[in]   r                               The result of the application control start response @n
-        *                                                              The exception code may be given through this parameter.
-        * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_OPERATION_CANCELED    The application control resolve request is canceled by a user operation.
-        * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @exception   E_SYSTEM                A system error has occurred.
+        * @param[in]   appId                                   The ID of the requested application
+        * @param[in]   operationId                             The operation ID used in the application control invocation
+        * @param[in]   r                                               The result of the application control start response @n
+        *                                                                              The following exceptions may be given through this parameter.
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_OPERATION_CANCELED    The application control resolve request has been cancelled by the user operation.
+        * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
+        * @exception   E_SYSTEM                                A system error has occurred.
         * @remarks             This method is invoked only for the implicit AppControl resolution.
-        * @see AppControl
         * @see AppControl::FindAndStart()
         */
        virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {}