Update doxygen comments
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / item-view / item-factory.h
index 22e5261..db4825a 100644 (file)
@@ -33,7 +33,9 @@ namespace Toolkit
 
 /**
  * @brief ItemFactory is for providing actors to ItemView.
+ *
  * Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
+ * @SINCE_1_0.0
  */
 class ItemFactory
 {
@@ -43,36 +45,41 @@ public:
 
   /**
    * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
   DALI_EXPORT_API virtual ~ItemFactory() {};
 
   /**
-   * @brief Query the number of items available from the factory.
+   * @brief Queries the number of items available from the factory.
    *
    * The maximum available item has an ID of GetNumberOfItems() - 1.
-   * @return the number of items
+   * @SINCE_1_0.0
+   * @return The number of items
    */
   virtual unsigned int GetNumberOfItems() = 0;
 
   /**
-   * @brief Create an Actor to represent a visible item.
+   * @brief Creates an Actor to represent a visible item.
    *
-   * @param[in] itemId The ID of the newly visible item.
-   * @return An actor, or an uninitialized pointer if the ID is out of range.
+   * @SINCE_1_0.0
+   * @param[in] itemId The ID of the newly visible item
+   * @return An actor, or an uninitialized pointer if the ID is out of range
    */
   virtual Actor NewItem(unsigned int itemId) = 0;
 
   /**
-   * @brief Notify the factory the actor representing the item is removed from ItemView.
+   * @brief Notifies the factory the actor representing the item is removed from ItemView.
    *
-   * @param[in] itemId The ID of the released item.
-   * @param[in] actor The actor that represents the released item.
+   * @SINCE_1_0.0
+   * @param[in] itemId The ID of the released item
+   * @param[in] actor The actor that represents the released item
    */
   virtual void ItemReleased(unsigned int itemId, Actor actor) {};
 
   /**
-   * Retrieve the extension for this control
+   * @brief Retrieves the extension for this control.
    *
+   * @SINCE_1_0.0
    * @return The extension if available, NULL otherwise
    */
   virtual Extension* GetExtension()