X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFWebCtrlWebStorageManager.h;h=f0cb286089c35aad685b968852218546f023b87e;hb=63d044b184154f923ac4bc3341d8477b5b0dc468;hp=5c8109595a854370a2d97f64525ad602c0ff93cc;hpb=86daf9e9f4a4ec7fffd9b80556243f16ff1239ee;p=framework%2Fosp%2Fweb.git diff --git a/inc/FWebCtrlWebStorageManager.h b/inc/FWebCtrlWebStorageManager.h index 5c81095..f0cb286 100755 --- a/inc/FWebCtrlWebStorageManager.h +++ b/inc/FWebCtrlWebStorageManager.h @@ -17,7 +17,7 @@ /** * @file FWebCtrlWebStorageManager.h -* @brief This is the header file for the %WebStorageManager class. +* @brief This is the header file for the %WebStorageManager class. * * This header file contains the declarations of the %WebStorageManager class for a %Web control. */ @@ -79,9 +79,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * - * @return A pointer to IList containing origin(Tizen::Base::String) list, @n - * else @c null if no web storage data exists - * @param[in] storageType The web storage type + * @return A pointer to Tizen::Base::Collection::IList that contains the origin(Tizen::Base::String) list, @n + * else @c null if no web storage data exists + * @param[in] storageType The web storage type * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -90,17 +90,17 @@ public: Tizen::Base::Collection::IList* GetOriginListN(WebStorageType storageType) const; /** - * Sets the default quota for a given origin for a given storage type. @n - * Only the @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE and the @c WEB_STORAGE_TYPE_APPLICATION_CACHE are supported. + * Sets the default quota for a given origin of a given storage type. @n + * Only @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE and @c WEB_STORAGE_TYPE_APPLICATION_CACHE are supported. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * * @return An error code - * @param[in] storageType The web storage type - * @param[in] origin The origin - * @param[in] quota The quota of the web storage to set in bytes + * @param[in] storageType The web storage type + * @param[in] origin The origin + * @param[in] quota The quota of the web storage to set in bytes * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c origin is invalid. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. @@ -110,16 +110,16 @@ public: /** - * Gets the quota for a given origin for a given storage type. @n - * Only the @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE is supported. + * Gets the quota for a given origin of a given storage type. @n + * Only @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE is supported. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * * @return The usage of the web storage in bytes - * @param[in] storageType The web storage type - * @param[in] origin The origin + * @param[in] storageType The web storage type + * @param[in] origin The origin * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c origin is invalid. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. @@ -128,16 +128,16 @@ public: long GetQuotaForOrigin(WebStorageType storageType, const Tizen::Base::String& origin); /** - * Gets the usage for a given origin for a given storage type. @n - * The @c WEB_STORAGE_TYPE_INDEXED_DATABASE and the @c WEB_STORAGE_TYPE_FILE_SYSTEM are not supported. + * Gets the usage for a given origin of a given storage type. @n + * @c WEB_STORAGE_TYPE_INDEXED_DATABASE and @c WEB_STORAGE_TYPE_FILE_SYSTEM are not supported. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * * @return The usage of the web storage in bytes - * @param[in] storageType The web storage type - * @param[in] origin The origin + * @param[in] storageType The web storage type + * @param[in] origin The origin * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c origin is invalid. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. @@ -147,16 +147,16 @@ public: long GetUsageForOrigin(WebStorageType storageType, const Tizen::Base::String& origin) const; /** - * Removes the data for a given origin for a given storage type. @n - * The @c WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported. + * Removes the data for a given origin of a given storage type. @n + * @c WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * * @return An error code - * @param[in] storageType The web storage type - * @param[in] origin The origin + * @param[in] storageType The web storage type + * @param[in] origin The origin * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c origin is invalid. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. @@ -166,14 +166,14 @@ public: result Remove(WebStorageType storageType, const Tizen::Base::String& origin); /** - * Removes all data for a given storage type. + * Removes all the data of a given storage type. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * * @return An error code - * @param[in] storageType The web storage type + * @param[in] storageType The web storage type * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -182,12 +182,12 @@ public: result RemoveAll(WebStorageType storageType); /** - * Gets the web storage manager instance. + * Gets a web storage manager instance. * * @since 2.1 * * @return A pointer to the %WebStorageManager instance, @n - * else @c null if it fails + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method.