modify exception
[framework/osp/web.git] / inc / FWebCtrlPageNavigationList.h
old mode 100755 (executable)
new mode 100644 (file)
index 28ff019..34f3d5e
@@ -42,12 +42,12 @@ namespace Tizen { namespace Web { namespace Controls
 {
 
 /**
- * @class      PageNavigationList
- * @brief              This class contains the back and forward list for a Web control.
+ * @class              PageNavigationList
+ * @brief              This class contains the back and forward list for a %Web control.
  *
- * @since      2.0
+ * @since              2.0
  *
- * The %PageNavigationList class provides the back and forward list for a Web control.
+ * The %PageNavigationList class provides the back and forward list for a %Web control.
  * @n
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
  */
@@ -68,7 +68,7 @@ public:
         * @since               2.0
         *
         * @return              The current history item, @n
-        *              else @c null if no history item exists
+        *                              else @c null if no history item exists
         */
        const Tizen::Web::HistoryItem* GetCurrentItem(void) const;
 
@@ -78,25 +78,25 @@ public:
         * @since               2.0
         *
         * @return              The index of the currently viewed page in the web page navigation list, @n
-        *                                      else @c -1 if no history item exists
+        *                              else @c -1 if no history item exists
         */
        int GetCurrentIndex(void) const;
 
        /**
-        * Gets the history item pointed to by the specified @c index.
+        * Gets the history item that the specified @c index points to.
         *
         * @since               2.0
         *
         * @return              A pointer to the history item at the specified @c index
-        * @param[in]   index           The index of an element @n
-        *                           The value of the index must be greater than or equal to @c 0.
-        * @exception   E_OUT_OF_RANGE  The specified @c index is out of range.
-        * @remarks     The specific error code can be accessed using the GetLastResult() method.
+        * @param[in]   index                           The index of the element @n
+        *                                                                      The value of the index must be greater than or equal to @c 0.
+        * @exception   E_OUT_OF_RANGE          The specified @c index is out of the valid range.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        const Tizen::Web::HistoryItem* GetItemAt(int index) const;
 
        /**
-        * Gets the total number of the history items.
+        * Gets the total number of history items.
         *
         * @since               2.0
         *
@@ -115,7 +115,7 @@ private:
        //
        // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @param[in]   item            The instance of the %PageNavigationList class to copy from
+       // @param[in]   item                    The instance of the %PageNavigationList class to copy from
        // @remarks             This constructor is hidden.
        //
        PageNavigationList(const PageNavigationList& item);
@@ -123,7 +123,7 @@ private:
        //
        // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
        //
-       // @param[in]   item            The instance of the %PageNavigationList class to assign from
+       // @param[in]   item                    The instance of the %PageNavigationList class to assign from
        // @remarks             This operator is hidden.
        //
        PageNavigationList& operator =(const PageNavigationList& item);