X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppAppSetting.h;h=df63ca944a07d55c52ec98532db6c007ee648fdd;hb=72749ddd32dd1e3e2833ada50fad8fceefbdcddc;hp=0d4d2c8b71917ef4397d98c3b7aab1c1a190290a;hpb=02bd6cfc04b38de9c0fce87de6422033cfc1228d;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FAppAppSetting.h b/inc/FAppAppSetting.h
index 0d4d2c8..df63ca9 100644
--- a/inc/FAppAppSetting.h
+++ b/inc/FAppAppSetting.h
@@ -52,13 +52,15 @@ class IAppSettingEventListener;
* The %AppSetting class is a helper class for an application to save or restore its settings.
* A setting entity is composed of a string-typed key and a value. The value type must be only of these three types: @c int, @c bool, and @c String.
* The settings are pre-defined in setting/setting.xml in the application's base directory
- * and they can be easily set with Tizen IDE (Creating and Using Application Settings, Application Settings Editor).
+ * and they can be easily set with %Tizen IDE (Creating and Using Application Settings, Application Settings Editor).
* (The setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n
* The %AppSetting class is basically used for specific applications such as IME, which have no UI.
* Because the applications have no external way to modify their settings, users can adjust the setting values through the setting application, which is delegated to manage the settings.
- * For supporting the consistency of setting values between two applications, the target application and the setting application, when setting a value in the setting application, the target application is notified from the setting application through OnAppSettingChanged()(see IAppSettingEventListener).
+ * For supporting the consistency of setting values between two applications, the target application and the setting application, when setting a value in the setting application, the target application is notified from the setting application through
+ * IAppSettingEventListener::OnAppSettingChanged()
* For detailed example on this class, see Task: App Setting.
*
+ * @see IAppSettingEventListener
*/
class _OSP_EXPORT_ AppSetting
: public Tizen::Base::Object
@@ -69,13 +71,12 @@ public:
*
* @since 2.0
*
- * @return A pointer to the %AppSetting instance, @n
+ * @return A pointer to the %AppSetting instance for the last setting, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks It returns an instance for the latest setting. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AppSetting* GetInstance(void);
@@ -144,13 +145,12 @@ public:
*
* @since 2.0
*
- * @return A pointer to the list that contains the Tizen::Base::String instances of version list
+ * @return A pointer to the list that contains the Tizen::Base::String instances of version list @n
+ * The latest version string is located in the first position. If the old version does not exist then return empty collection.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The latest version string is located in the first position.
- * If the old version does not exist then return empty collection. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Base::Collection::IList* GetAppSettingVersionListN(void);