Merge "Fix memory leak on imei" into tizen_2.2
[platform/framework/native/appfw.git] / inc / FAppApp.h
index 29ed7c0..851b84f 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);
@@ -144,7 +143,7 @@ public:
        /**
         * Gets the display name of the application. @n
         * If the system language setting is changed, the %GetAppDisplayName() method returns the localized application name.
-        * The display name is displayed in applications like Launcher, Setting, Task Manager, and so on.
+        * The display name is displayed in applications like Launcher, Setting, Task Switcher, and so on.
         *
         * @since       2.0
         *
@@ -209,7 +208,7 @@ public:
 
        /**
         * Terminates the application while it is running. @n
-        * The OnAppTerminating() method is called after the %Terminate() method is executed successfully.
+        * The %Terminate() method can be called explicitly by the application. The OnAppTerminating() method is called after this method is executed successfully.
         *
         * @since       2.0
         *
@@ -264,15 +263,14 @@ public:
         * All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method.
         * After this method, the application code cannot be executed. The application is destroyed subsequently. @n
         *
-        * An application can be terminated by either system, such as power-off and OOM, or others, such as self and other applications. @n
-        * When the termination by system, called an “urgent termination”, occurs, the method, %OnAppTerminating(), cannot be executed properly.
-        * For more details, while power-off, even if %OnAppTerminating() is called, it has a short time for executing. If the application is killed by OOM, %OnAppTerminating() is not called. @n
-        * Because %OnAppTerminating() is not likely to be called due to urgent termination, the application should save the critical data as they can do.
-        * For example, the application can set the check point or use the callback for low memory. @n
-        * When the termination by self or other applications, called a “normal termination”, occurs, the method, %OnAppTerminating(), can be executed properly.
-        * It provides more time for executing than urgent termination, but limits to the time to 3 or 5 seconds. @n
-        * The main loop is already quitted when %OnAppTerminating() is called.
-        * Thus, the application should not use a kind of asynchronous API of which the callback is triggered by the main loop.
+        * An application's termination is triggered either by the system or other applications. @n
+        * When the termination is triggered by the system because of conditions such as power-off and OOM, it is called "urgent termination" and during these terminations %OnAppTerminating(), cannot be executed properly.
+        * When an application is terminated because of a power-off, although this method is called, it should be executed in a short duration. And when an application is killed by OOM, this method is not called. @n
+        * This implies that this method is not likely to be called during an urgent termination, and hence the application should save the critical data as often as possible.
+        * For example, the application can set a check point or use the callback for low memory.
+        * When an application is terminated by self or other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for executing it as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n
+        * When this method is called, the main loop has already been quit.
+        * Thus, the application should not use any kind of asynchronous API that has callbacks triggered by the main loop.
         *
         * @since       2.0
         *
@@ -294,7 +292,7 @@ public:
 
        /**
         * Called when the battery level changes. @n
-        * It is recommended that the application consuming more battery power must be terminated if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
+        * It is recommended that the application decides whether to terminate by itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL.
         *
         * @since       2.0
         *
@@ -316,8 +314,7 @@ public:
        result SendUserEvent(RequestId requestId, const Tizen::Base::Collection::IList* pArgs);
 
        /**
-       * Called asynchronously when the user event is sent by the SendUserEvent() method. @n
-       * The request ID and argument format for the user event can be defined as per the requirement.
+       * Called asynchronously when the user event is sent by the SendUserEvent() method.
        *
        * @since        2.0
        *