Update doxygen comments

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / item-view / item-view.h

diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
old mode 100644 (file)
new mode 100755 (executable)
index 92fe4bd..60dba05
--- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
+++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
@@ -68,6 +68,10 @@ class DALI_IMPORT_API ItemView : public Scrollable
 {
 public:
 
+  /**
+   * @brief The start and end property ranges for this control.
+   * @SINCE_1_1.18
+   */
   enum PropertyRange
   {
     PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1,                        ///< @SINCE_1_1.18
@@ -78,11 +82,15 @@ public:
   };
 
   /**
-   * @brief An enumeration of properties belonging to the ScrollView class.
+   * @brief Enumeration for the instance of properties belonging to the ScrollView class.
    * @SINCE_1_0.0
    */
   struct Property
   {
+    /**
+     * @brief Enumeration for the instance of properties belonging to the ScrollView class.
+     * @SINCE_1_0.0
+     */
     enum
     {
       // Event side properties
@@ -119,12 +127,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] itemView Handle to an object
    */
   ItemView( const ItemView& itemView );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] itemView Handle to an object
+   * @return A reference to this
    */
   ItemView& operator=( const ItemView& itemView );
 
@@ -411,11 +422,12 @@ public:
    *
    * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
    * the items with ID 3 or greater will be moved:
-   *   Initial actors:     After remove:
-   *     ID 1 - ActorA       ID 1 - ActorA
-   *     ID 2 - ActorB       ID 2 - ActorC (previously ID 3)
-   *     ID 3 - ActorC       ID 3 - ActorB (previously ID 4)
-   *     ID 4 - ActorD
+   *  | Initial actors:    | After remove:  |
+   *  |:------------------ |:-------------- |
+   *  |  ID 1 - ActorA     |  ID 1 - ActorA |
+   *  |  ID 2 - ActorB     |  ID 2 - ActorC (previously ID 3) |
+   *  |  ID 3 - ActorC     |  ID 3 - ActorB (previously ID 4) |
+   *  |  ID 4 - ActorD     |                |
    * @SINCE_1_0.0
    * @param[in] itemId The Item ID of the item to remove.
    * @param[in] durationSeconds How long the relayout takes in seconds.