Init Tizen 2.2.1

[framework/osp/web.git] / inc / FWebWebBookmark.h

diff --git a/inc/FWebWebBookmark.h b/inc/FWebWebBookmark.h
old mode 100755 (executable)
new mode 100644 (file)
index d996c12..ac84ae3
--- a/inc/FWebWebBookmark.h
+++ b/inc/FWebWebBookmark.h
@@ -39,14 +39,14 @@ class _WebBookmarkImpl;
 
 /**
  * @class              WebBookmark
- * @brief              This class provides methods to manage bookmark items of the browser.
+ * @brief              This class provides methods to manage the bookmark items of the browser.
  *
  * @since              2.1
  *
  * @final              This class is not intended for extension.
  *
- * The %WebBookmark class provides methods to get bookmark information of the browser and organize it.
- * The bookmark system has hierarchical structure with the parent folder ID supporting multiple folders and the bookmark items are represented by the BookmarkItem class. @n
+ * The %WebBookmark class provides methods to get the browser's bookmark information and organize it.
+ * The bookmark system has a hierarchical structure with the parent folder ID supporting multiple folders and the bookmark items are represented by the BookmarkItem class. @n
  * If you use these APIs to backup and restore the bookmark, add bookmark items and folders recursively from the topmost level.
  */
 class _OSP_EXPORT_ WebBookmark
@@ -87,9 +87,9 @@ public:
         * @privilege   %http://tizen.org/privilege/bookmark.write
         *
         * @return              An error code
-        * @param[in]   title                   The title of bookmark item
-        * @param[out]  folderId                The current folder ID
-        * @param[in]   parentId                The parent folder ID
+        * @param[in]   title                           The title of a bookmark item
+        * @param[out]  folderId                        The current folder ID
+        * @param[in]   parentId                        The parent folder ID
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                       - The specified title is an empty string. @n
@@ -110,10 +110,10 @@ public:
         * @privilege   %http://tizen.org/privilege/bookmark.write
         *
         * @return              An error code
-        * @param[in]   title                   The title of bookmark item
-        * @param[in]   url                             The URL of bookmark item
-        * @param[out]  bookmarkId              The current bookmark ID
-        * @param[in]   parentId                The parent folder ID
+        * @param[in]   title                           The title of a bookmark item
+        * @param[in]   url                                     The URL of a bookmark item
+        * @param[out]  bookmarkId                      The current bookmark ID
+        * @param[in]   parentId                        The parent folder ID
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           Either of the following conditions has occurred: @n
         *                                                                       - The specified @c title is an empty string. @n
@@ -134,8 +134,8 @@ public:
         * @privilege   %http://tizen.org/privilege/bookmark.write
         *
         * @return              An error code
-        * @param[in]   bookmarkId              The bookmark ID
-        * @param[in]   favicon                 The favicon image
+        * @param[in]   bookmarkId                      The bookmark ID
+        * @param[in]   favicon                         The favicon image
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           The specified @c bookmarkId is invalid.
         * @exception   E_INVALID_DATA          The specified @c favicon data is invalid.
@@ -146,17 +146,17 @@ public:
        result SetFavicon(RecordId bookmarkId, const Tizen::Graphics::Bitmap& favicon);
 
        /**
-        * Gets the bookmark item pointed to by the specified @c index.
+        * Gets the bookmark item that the specified @c index points to.
         *
         * @since               2.1
         * @privlevel   platform
         * @privilege   %http://tizen.org/privilege/bookmark.read
         *
         * @return              The bookmark item at the specified @c index
-        * @param[in]   index                   The index of an element @n
-        *                                                              The value of the @c index must be greater than or equal to @c 0.
+        * @param[in]   index                           The index of the element @n
+        *                                                                      The value of the @c index must be greater than or equal to @c 0.
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified @c index is out of range.
+        * @exception   E_OUT_OF_RANGE          The specified @c index is out of the valid range.
         * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
@@ -177,7 +177,7 @@ public:
        int GetItemCount(void) const;
 
        /**
-        * Removes all elements.
+        * Removes all the elements.
         *
         * @since               2.1
         * @privlevel   platform