*
* @final This class is not intended for extension.
*
- * The %AppRegistry class lets an application to save or restore its preferences.
+ * The %AppRegistry class lets an application save or restore its preferences.
* An instance of this class can be obtained through the Application class.
* Also, since an application's state is generally restored in the App::OnAppInitializing() method and saved in the App::OnAppTerminating() method, an instance of this class is passed as an argument when these methods are invoked.
* @n
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, const Tizen::Base::String& value);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, int value);
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The floating point value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
- * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Add(const Tizen::Base::String& key, double value);
/**
- * Sets a string value associated with the specified @c key.
+ * Sets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A string value
+ * @return An error code
+ * @param[in] key The key corresponding to the string value
+ * @param[in] value The string value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, const Tizen::Base::String& value);
/**
- * Sets an integer value associated with the specified @c key.
+ * Sets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value An integer value
+ * @return An error code
+ * @param[in] key The key corresponding to the integer value
+ * @param[in] value The integer value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
result Set(const Tizen::Base::String& key, int value);
/**
- * Sets a floating point value associated with the specified @c key.
+ * Sets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key A key corresponding to the value
- * @param[in] value A floating point value
+ * @return An error code
+ * @param[in] key The key corresponding to the floating point value
+ * @param[in] value The floating point value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
* @remarks In order to save the value in the persistent storage, the Save() method must be called.
*/
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @exception E_SUCCESS The method is successful.
*/
result Save(void);
/**
- * Removes a preference associated with the specified @c key.
+ * Removes the preference associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to remove
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] key The key of the value to remove
+ * @exception E_SUCCESS The method is successful.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Remove(const Tizen::Base::String& key);
/**
- * Gets a string value associated with the specified @c key.
+ * Gets the string value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A string value to retrieve
+ * @return An error code
+ * @param[in] key The key of the string value to retrieve
+ * @param[out] value The string value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, Tizen::Base::String& value) const;
/**
- * Gets an integer value associated with the specified @c key.
+ * Gets the integer value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value An integer value to retrieve
+ * @return An error code
+ * @param[in] key The key of the integer value to retrieve
+ * @param[out] value The integer value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, int& value) const;
/**
- * Gets a floating point value associated with the specified @c key.
+ * Gets the floating point value associated with the specified @c key.
*
* @since 2.0
*
- * @return An error code
- * @param[in] key The key of the value to retrieve
- * @param[out] value A floating point value to retrieve
+ * @return An error code
+ * @param[in] key The key of the floating point value to retrieve
+ * @param[out] value The floating point value to retrieve
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly.
+ * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly.
* @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences.
*/
result Get(const Tizen::Base::String& key, double& value) const;
/**
- * Gets the %AppRegistry instance pointer.
+ * Gets a pointer to the %AppRegistry instance.
*
* @since 2.0
*
- * @return A pointer to the %AppRegistry instance, @n
- * else @c null if it fails
+ * @return A pointer to the %AppRegistry instance, @n
+ * else @c null if it fails
*/
static AppRegistry* GetInstance(void);
projects / platform / framework / native / appfw.git / blobdiff