doxygen comment was modified.

[platform/framework/native/uifw.git] / inc / FUiCtrlIGroupedListViewItemProviderF.h

diff --git a/inc/FUiCtrlIGroupedListViewItemProviderF.h b/inc/FUiCtrlIGroupedListViewItemProviderF.h
index 0439967..a5962c2 100644 (file)
--- a/inc/FUiCtrlIGroupedListViewItemProviderF.h
+++ b/inc/FUiCtrlIGroupedListViewItemProviderF.h
@@ -21,8 +21,8 @@
  * @brief      This is the header file for the %IGroupedListViewItemProviderF interface.
  *
  * This header file contains the declarations of the %IGroupedListViewItemProviderF interface. @n
- * If an event is generated, a method of this class is called. @n
- * Therefore, if an application performs jobs related to the item events, it uses the methods of this class.
+ * If an event is generated, a method of this interface is called. @n
+ * Therefore, if an application performs jobs related to the item events, it uses the methods of this interface.
  *
  */
 #ifndef _FUI_CTRL_IGROUPED_LIST_VIEW_ITEM_PROVIDERF_H_
@@ -41,8 +41,7 @@ namespace Tizen {namespace Ui { namespace Controls
  * @since              2.1
  *
  * The %IGroupedListViewItemProviderF interface is the interface for handling GroupedListView items.
- * The class that handles list items implements this interface, and the instance created using the GroupedListView's Construct()
- * method.
+ * The class that handles list items implements this interface, and the instance created using the GroupedListView::Construct() method.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_listviews.htm">ListViews</a>.
  */
@@ -50,7 +49,7 @@ class _OSP_EXPORT_ IGroupedListViewItemProviderF
 {
 // Operation
 public:
-       /*
+       /**
         * This polymorphic destructor should be overridden if required.
         * This way, the destructors of the derived classes are called
         * when the destructor of this interface is called.
@@ -59,7 +58,7 @@ public:
         */
        virtual ~IGroupedListViewItemProviderF(void) {}
 
-       /*
+       /**
         * Gets the total number of groups.
         *
         * @since       2.1
@@ -69,7 +68,7 @@ public:
         */
        virtual int GetGroupCount(void) = 0;
 
-       /*
+       /**
         * Gets the total number of items in the specified group.
         *
         * @since       2.1
@@ -80,7 +79,7 @@ public:
         */
        virtual int GetItemCount(int groupIndex) = 0;
 
-       /*
+       /**
         * Creates the group item for the specified index from the item provider.
         *
         * @since       2.1
@@ -95,7 +94,7 @@ public:
         */
        virtual Tizen::Ui::Controls::GroupItem* CreateGroupItem(int groupIndex, float itemWidth) = 0;
 
-       /*
+       /**
         * Deletes the specified group item.
         *
         * @since       2.1
@@ -103,7 +102,7 @@ public:
         * @return  @c true if the item is deallocated by this method, @n
         *          else @c false
         * @param[in] groupIndex        The index of the group
-        * @param[in] pItem             The pointer to GroupItem that is to be deleted
+        * @param[in] pItem             The pointer to GroupItem to delete
         * @param[in] itemWidth         The width of the item
         * @remarks  An application that uses the %GroupedListView control must implement this method. @n
         *                      Using this method, an application can deallocate the item. @n
@@ -113,7 +112,7 @@ public:
         */
        virtual bool DeleteGroupItem(int groupIndex, Tizen::Ui::Controls::GroupItem* pItem, float itemWidth) = 0;
 
-       /*
+       /**
         * Creates the specified item.
         *
         * @since       2.1
@@ -131,7 +130,7 @@ public:
         */
        virtual Tizen::Ui::Controls::ListItemBase* CreateItem(int groupIndex, int itemIndex, float itemWidth) = 0;
 
-       /*
+       /**
         * Deletes the specified item.
         *
         * @since       2.1
@@ -140,7 +139,7 @@ public:
         *                      else @c false
         * @param[in] groupIndex        The index of the group
         * @param[in] itemIndex         The index of the item
-        * @param[in] pItem             The pointer to ListItemBase that is to be deleted
+        * @param[in] pItem             The pointer to ListItemBase to delete
         * @param[in] itemWidth         The width of the item
         * @remarks  An application that uses the GroupedListView control must implement this method. @n
         *                      Using this method, an application can deallocate the item. @n
@@ -150,7 +149,7 @@ public:
         */
        virtual bool DeleteItem(int groupIndex, int itemIndex, Tizen::Ui::Controls::ListItemBase* pItem, float itemWidth) = 0;
 
-       /*
+       /**
         * Checks whether the item can be reordered.
         *
         * @since 2.1