Apply reviewed doxygen

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

diff --git a/inc/FWebBookmarkItem.h b/inc/FWebBookmarkItem.h
old mode 100755 (executable)
new mode 100644 (file)
index 08ef21d..3cb4e16
--- a/inc/FWebBookmarkItem.h
+++ b/inc/FWebBookmarkItem.h
@@ -38,7 +38,7 @@ class _BookmarkItemImpl;
 
 /**
  * A unique ID. This ID is unique within a local storage only. @n
- * @c RecordId is assigned by the local storage when a record is saved to the storage. @n
+ * @c RecordId is assigned by the local storage when a record is saved to the storage.
  * 
  *
  * @since              2.1
@@ -47,7 +47,7 @@ typedef int RecordId;
 
 /**
  * The root folder ID. @n
- * In fact, it is symbolic value because the root folder record doesn't exist physically.
+ * In fact, it is a symbolic value because the root folder record does not exist physically.
  *
  * @since              2.1
  */
@@ -55,13 +55,14 @@ const RecordId ROOT_FOLDER_ID = -1;
 
 /**
 * @class               BookmarkItem
-* @brief               This class is used for accessing a bookmark item stored in the WebBookmark class.
+* @brief               This class is used for accessing a bookmark item stored in the %WebBookmark class.
 *
 * @since               2.1
+*
 * @final               This class is not intended for extension.
 *
 * The %BookmarkItem class provides access to the WebBookmark class.
-* Each item contains the title, the URL of the page, the item type and parent folder id.
+* Each item contains the title, the URL of a page, the item type, and the parent folder ID.
 */
 class _OSP_EXPORT_ BookmarkItem
        : public Tizen::Base::Object
@@ -75,7 +76,7 @@ public:
         *
         * @since               2.1
         *
-        * @param[in] setting An instance of %BookmarkItem
+        * @param[in] rhs An instance of %BookmarkItem to copy
         */
        BookmarkItem(const BookmarkItem& rhs);
 
@@ -101,43 +102,40 @@ public:
         * @since               2.1
         *
         * @return              The URL of the current bookmark item @n
-        *                              If the item type is folder, this method will return the empty string.
+        *                              If the item type is folder, this method returns an empty string.
         * @see IsFolder()
         */
        Tizen::Base::String GetUrl(void) const;
 
        /**
-        * Gets the favicon image from current bookmark item.
+        * Gets the favicon image from the current bookmark item.
         *       
         * @since               2.1
         *
         * @return              The image
-        *
         * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_SYSTEM        Either of the following conditions has occurred: @n
-        *                                              - The method cannot proceed due to a severe system error. @n
-        *                                              - The method has failed because it doesn¡¯t work on a service application.
+        * @exception   E_SYSTEM        The method cannot proceed due to a severe system error.
         * @remarks     The specific error code can be accessed using the GetLastResult() method.
         */
        Tizen::Graphics::Bitmap* GetFaviconN(void) const;
 
        /**
-        * Gets the parent folder id of the current bookmark item. 
+        * Gets the parent folder ID of the current bookmark item. 
         *
         * @since               2.1
         *
-        * @return              The parent folder id of the current bookmark item @n
-        *                              If the current bookmark item is the one in topmost level, this method will return ::ROOT_FOLDER_ID.
+        * @return              The parent folder ID of the current bookmark item @n
+        *                              If the current bookmark item is the one at the topmost level, this method returns ::ROOT_FOLDER_ID.
         */
        RecordId GetParentFolderId(void) const;
 
        /**
-        * Checks whether the type of current bookmark item is folder or not.
+        * Checks whether the type of the current bookmark item is folder or not.
         *
         * @since               2.1
         *
-        * @return              @c true if the type of current bookmark item is folder, @n
-        *                                      else @c false
+        * @return              @c true if the type of the current bookmark item is folder, @n
+        *                              else @c false
         */
        bool IsFolder(void) const;
 
@@ -156,18 +154,18 @@ public:
         * @since               2.1
         *
         * @return              @c true if the two instances match, or if and only if the two instances contain the same elements, @n
-        *                                      else @c false @n
+        *                              else @c false
         * @param[in]   obj                             The object to compare with the current instance
         * @see Tizen::Base::Object::Equals()
         */
-       virtual bool Equals(const Object& obj) const;
+       virtual bool Equals(const Tizen::Base::Object& obj) const;
 
        /**
         * Copying of objects using this copy assignment operator is allowed. 
         *
         * @since               2.1
         *
-        * @param[in]   setting                 The instance of the %BookmarkItem class to assign from
+        * @param[in]   rhs                     An instance of the %BookmarkItem class to assign
         */
        BookmarkItem& operator =(const BookmarkItem& rhs);