Merge "Update deprecated libprivilege-control API functions." into tizen

[platform/framework/native/appfw.git] / inc / FAppIAppFrame.h

diff --git a/inc/FAppIAppFrame.h b/inc/FAppIAppFrame.h
index 646db61..14c5248 100644 (file)
--- a/inc/FAppIAppFrame.h
+++ b/inc/FAppIAppFrame.h
@@ -15,8 +15,8 @@
 //
 
 /**
- * @file                       FAppIAppFrame.h
- * @brief                      This is the header file for the %IAppFrame interface.
+ * @file               FAppIAppFrame.h
+ * @brief              This is the header file for the %IAppFrame interface.
  *
  * This header file contains the declarations of the %IAppFrame interface.
  */
@@ -39,13 +39,14 @@ namespace Tizen { namespace App
  *
  * @since      2.0
  *
- * The %IAppFrame interface provides methods for the application frame. A frame is the outermost boundary of the application UI.
+ * The %IAppFrame interface provides methods for the application frame.
+ * A frame is the outermost boundary of the application UI.
  */
 class IAppFrame
 {
 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,7 +58,7 @@ public:
         *
         * @since       2.0
         *
-        * @return      A pointer to the Tizen::Graphics::Canvas class
+        * @return      A pointer to the Tizen::Graphics::Canvas instance
         */
        virtual Tizen::Graphics::Canvas* GetCanvasN(void) const = 0;
 
@@ -66,8 +67,8 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::IKeyEventListener instance to add
+        * @return              An error code
+        * @param[in]   listener                        An instance of Tizen::Ui::IKeyEventListener to add
         * @exception   E_SUCCESS                       The method is successful.
         */
        virtual result AddKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
@@ -77,8 +78,8 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::IKeyEventListener instance to remove
+        * @return              An error code
+        * @param[in]   listener        An instance of Tizen::Ui::IKeyEventListener to remove
         * @exception   E_SUCCESS       The method is successful.
         */
        virtual result RemoveKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0;
@@ -88,9 +89,9 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::ITouchEventListener instance to add
-        * @exception   E_SUCCESS                       The method is successful.
+        * @return              An error code
+        * @param[in]   listener                An instance of Tizen::Ui::ITouchEventListener to add
+        * @exception   E_SUCCESS               The method is successful.
         */
        virtual result AddTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
 
@@ -99,8 +100,8 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::ITouchEventListener instance to add
+        * @return              An error code
+        * @param[in]   listener        An instance of Tizen::Ui::ITouchEventListener to add
         * @exception   E_SUCCESS       The method is successful.
         */
        virtual result RemoveTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0;
@@ -110,8 +111,8 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::IWindowEventListener instance to remove
+        * @return              An error code
+        * @param[in]   listener                        An instance of Tizen::Ui::IWindowEventListener to remove
         * @exception   E_SUCCESS                       The method is successful.
         */
        virtual result AddWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
@@ -121,8 +122,8 @@ public:
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   listener        A Tizen::Ui::IWindowEventListener instance to remove
+        * @return              An error code
+        * @param[in]   listener        An instance of Tizen::Ui::IWindowEventListener to remove
         * @exception   E_SUCCESS       The method is successful.
         */
        virtual result RemoveWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0;
@@ -132,11 +133,11 @@ public:
         *
         * @since       2.0
         *
-        * @return              A pointer to Tizen::Ui::Controls::Frame if successful, @n
-        *              else @c null
-        * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_INVALID_STATE This instance is in an invalid state.
-        * @exception   E_UNSUPPORTED_OPERATION This method cannot be supported.
+        * @return              A pointer to the Tizen::Ui::Controls::Frame instance, @n
+        *              else @c null if it fails
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_INVALID_STATE                 This instance is in an invalid state.
+        * @exception   E_UNSUPPORTED_OPERATION This method is not supported.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Ui::Controls::Frame* GetFrame(void) = 0;