Fix N_SE-56436 for Screen lock.
[platform/framework/native/appfw.git] / inc / FAppIAppControlEventListener.h
index e5a67f5..6bbd777 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
 //
 
 /**
- * @file                       FAppIAppControlEventListener.h
- * @brief                      This is the header file for the %IAppControlEventListener interface.
+ * @if OSPDEPREC
+ * @file               FAppIAppControlEventListener.h
+ * @brief              This is the header file for the %IAppControlEventListener interface.
  *
  * This header file contains the declarations of the %IAppControlEventListener interface.
+ * @endif
  */
 
 #ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
@@ -36,7 +37,7 @@ namespace Tizen { namespace App
 /**
 * @if OSPDEPREC
 * @interface   IAppControlEventListener
-* @brief               <i>[Deprecated]</i> This interface defines a listener for the AppControl result events.
+* @brief               <i>[Deprecated]</i> This interface defines a listener for the %AppControl result events.
 *
 * @deprecated  This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
 * @since       2.0
@@ -50,7 +51,7 @@ class _OSP_EXPORT_ IAppControlEventListener
 public:
        /**
         * @if OSPDEPREC
-        * 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.
         *
         * @brief       <i> [Deprecated] </i>
@@ -64,24 +65,24 @@ public:
        /**
         * @if OSPDEPREC
         * Called when the application control is completed. @n
-        * The client can get callback result for some application controls by implementing this listener. @n
-        * %OnAppControlCompleted() is called after AppControl::Start() with listener for some application controls.
+        * The client can get the callback result for some application controls by implementing this listener. @n
+        * The %OnAppControlCompleted() method is called after AppControl::Start() is done listening to application controls.
         *
         * @brief       <i> [Deprecated] </i>
         *
         * @deprecated  This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
         * @since       2.0
         *
-        * @param[in]   providerId      The provider ID
-        * @param[in]   operationId             The operation ID used in application control invocation
-        * @param[in]   pResultList             The list of callback strings of application control
+        * @param[in]   providerId              The provider ID
+        * @param[in]   operationId             The operation ID used for application control invocation
+        * @param[in]   pResultList             The list of callback strings for application control
         *
-        * @remarks     The specified @c pResultList provides the result code for the first array element.
-        * @remarks     When the invoked application control is terminated without sending a result,
-        *           then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
-        * @remarks     Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
-        *           (UiApp::OnForeground()). If %UiApp::OnForeground() is being used in the application logic,
-        *                      it is recommended to avoid switching forms in this listener.
+        * @remarks
+        *                              - The specified @c pResultList provides the result code for the first array element.
+        *                              - When the invoked application control is terminated without sending a result,
+        *                              then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
+        *                              - Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
+        *                              (UiApp::OnForeground()). @n If the %UiApp::OnForeground() method is being used in the application logic, it is recommended to avoid switching forms in this listener.
         * @see         Tizen::App::AppControl
         * @endif
         */