Update FApp documents from LB

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

diff --git a/inc/FAppTypes.h b/inc/FAppTypes.h
index 98f136b..bb4b873 100644 (file)
--- a/inc/FAppTypes.h
+++ b/inc/FAppTypes.h
@@ -16,9 +16,9 @@
 
 /**
  * @file               FAppTypes.h
- * @brief              This is the header file for the enumerations of the App class.
+ * @brief              This is the header file for the enumerations of the %App class.
  *
- *     This header file contains the declarations of the enumerations of the App class.
+ * This header file contains the declarations of the enumerations of the App class.
  * @see                        Application
  */
 
@@ -47,10 +47,10 @@ typedef Tizen::Base::String AppId;
 /**
  * @if OSPDEPREC
  * The application secret
- * @brief      <i> [Deprecated] </i>
+ * @brief              <i> [Deprecated] </i>
  * @deprecated This type is deprecated because the associated App::GetAppSecret() method is deprecated.
  *
- * @since      2.0
+ * @since              2.0
  * @endif
  */
 typedef Tizen::Base::String AppSecret;
@@ -65,8 +65,8 @@ enum AppState
 {
        INITIALIZING,   /**< The application has been launched */
        RUNNING,        /**< The application has been initialized and is currently being executed */
-       TERMINATING,    /**< The application is about to exit and releases its resources and saves its preferences */
-       TERMINATED  /**< The application has been destroyed */
+       TERMINATING,    /**< The application is about to exit, release its resources, and save its preferences */
+       TERMINATED      /**< The application has been destroyed */
 };
 
 /**
@@ -77,9 +77,9 @@ enum AppState
  */
 enum AppUiState
 {
-       APP_UI_STATE_FOREGROUND = 0x01,             /**< The application is completely visible on foreground */
+       APP_UI_STATE_FOREGROUND = 0x01,             /**< The application is completely visible in the foreground */
        APP_UI_STATE_PARTIAL_BACKGROUND = 0x02,     /**< The application is partially hidden by another window, such as a system pop-up */
-       APP_UI_STATE_BACKGROUND = 0x04              /**< The application is completely hidden by a full-screen window, usually by another application or an application control */
+       APP_UI_STATE_BACKGROUND = 0x04              /**< The application is completely hidden by a full-screen window, usually by another application, or an application control */
 };
 
 /**
@@ -92,42 +92,41 @@ enum AppCtrlResult
 {
        APP_CTRL_RESULT_SUCCEEDED = 0x00,       /**< The application operation is successful */
        APP_CTRL_RESULT_FAILED = 0x01,          /**< The application operation has failed */
-       APP_CTRL_RESULT_CANCELED = 0x02,        /**< The application operation is canceled by the callee application */
-       APP_CTRL_RESULT_TERMINATED = 0x04,      /**< The callee application is terminated without sending the result */
+       APP_CTRL_RESULT_CANCELED = 0x02,        /**< The application operation is cancelled by the calling application */
+       APP_CTRL_RESULT_TERMINATED = 0x04,      /**< The calling application is terminated without sending the result */
        APP_CTRL_RESULT_ABORTED = 0x08,         /**< The application operation is aborted by the platform */
 };
 
 /**
  * @if OSPDEPREC
  * The application launch request ID. @n
- * Represents the application launch arguments in App::App::OnUserEventReceivedN().
+ * Represents the application launch arguments in the App::App::OnUserEventReceivedN() method.
  *
  * @brief      <i> [Deprecated] </i>
- * @deprecated This variable is deprecated. From %Tizen API version 2.1, App::App::OnUserEventReceivedN()
- *                             is not invoked for the request from application and %AppLaunchRequestId is not used anymore.
+ * @deprecated This variable is deprecated. From Tizen API version 2.1, the App::App::OnUserEventReceivedN()
+ *                             method is not invoked for the request from the application and the %AppLaunchRequestId() method is not used anymore.
  *                             Instead, use IAppControlProviderEventListener.
- * @since      2.0
+ * @since              2.0
  *
- * @see     App::App::OnUserEventReceivedN()
  * @endif
  */
 const long AppLaunchRequestId = (-0xFFFF);
 
 /**
  * @if OSPDEPREC
- * Defines the launch type - normal launch.
+ * Defines the launch type, for example, normal launch.
  *
- * @brief      <i> [Deprecated] </i>
+ * @brief              <i> [Deprecated] </i>
  * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.
  *                             Instead of using this variable, it is recommended to use IAppControlProviderEventListener to acquire the launch information.
- * @since      2.0
+ * @since              2.0
  * @endif
  */
 _OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_NORMAL;
 
 /**
  * @if OSPDEPREC
- * Defines the launch type - conditional launch.
+ * Defines the launch type, for example, conditional launch.
  *
  * @brief      <i> [Deprecated] </i>
  * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future.