Revision of doxygen of some headers in App namespace

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

diff --git a/inc/FAppAppSetting.h b/inc/FAppAppSetting.h
index 2e5927f..0d4d2c8 100644 (file)
--- a/inc/FAppAppSetting.h
+++ b/inc/FAppAppSetting.h
@@ -49,58 +49,16 @@ class IAppSettingEventListener;
  *
  * @final      This class is not intended for extension.
  *
- * The %AppSetting class lets an application to save or restore its settings.
- *
- *
- * The following example demonstrates how to use the %AppSetting class.
- *
- * @code
- *     void
- *     AppSettingForm::RefreshSetting(void)
- *     {
- *             AppSetting* pAppSetting = AppSetting::GetInstance();
- *             AppAssert(pAppSetting);
- *
- *             bool valueBool = false;
- *             int valueInt = 0;
- *             const String strLn(L"\n");
- *             String valueString;
- *             String settingText;
- *
- *             AppAssert(pAppSetting->GetValue(L"checkbox1", valueBool) == E_SUCCESS);
- *             settingText += L"checkbox1: ";
- *             settingText += strFalseTrue[valueBool ? 1 : 0];
- *             settingText += strLn;
- *
- *             AppAssert(pAppSetting->GetValue(L"slider1", valueInt) == E_SUCCESS);
- *             settingText += L"slider1: ";
- *             settingText += Integer(valueInt).ToString();
- *             settingText += strLn;
- *
- *             AppAssert(pAppSetting->GetValue(L"editbox1", valueString) == E_SUCCESS);
- *             settingText += L"editbox1: ";
- *             settingText += valueString;
- *             settingText += strLn;
- *             // . . .
- *     }
- *
- *     void
- *     AppSettingForm::SetSettingValueSet1(void)
- *     {
- *             AppSetting* pAppSetting = AppSetting::GetInstance();
- *             AppAssert(pAppSetting);
- *
- *             AppAssert(pAppSetting->SetValue(L"checkbox1", false) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"slider1", 100) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"editbox1", String(L"AppSetting working!")) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"expanditem1", String(L"1 minute")) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"expanditem1", false) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"slider2", 0) == E_SUCCESS);
- *             AppAssert(pAppSetting->SetValue(L"editbox2", String(L"AppSetting running!")) == E_SUCCESS);
- *             // . . .
- *     }
- * @endcode
- *
+ * 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 (<a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/creating_running_app_setting.htm">Creating and Using Application Settings</a>, <a href="../org.tizen.native.appprogramming/html/ide_sdk_tools/application_settings_editor.htm">Application Settings Editor</a>).
+ * (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 detailed example on this class, see <a href="../org.tizen.native.appprogramming/html/tutorials/app_tutorial/task_app_settings.htm?resultof=%22%41%70%70%53%65%74%74%69%6e%67%22%20%22%61%70%70%73%65%74%74%69%6e%67%22%20">Task: App Setting</a>.
+ * 
  */
 class _OSP_EXPORT_ AppSetting
        : public Tizen::Base::Object