From fcc87538717836a4f9d9ca9ec7dfc242f5aa8431 Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Tue, 10 Jan 2017 14:19:34 +0900 Subject: [PATCH] Update doxygen comments - Fix the graph description in ItemView::RemoveItem() - Add some descriptions in more detail, checked by LB Change-Id: I98fb22b4b02830da42651c16e7dfe2bc207a5137 Signed-off-by: Seoyeon Kim --- .../public-api/controls/scrollable/item-view/item-view.h | 15 ++++++++------- .../controls/scrollable/scroll-view/scroll-view.h | 4 ++-- dali-toolkit/public-api/controls/table-view/table-view.h | 4 ++-- dali-toolkit/public-api/enums.h | 6 +++--- 4 files changed, 15 insertions(+), 14 deletions(-) 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 index d49d32c..60dba05 100755 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h @@ -82,13 +82,13 @@ 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 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 */ enum @@ -422,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. diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index 0028cd7..cb24960 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -492,13 +492,13 @@ 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 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 */ enum diff --git a/dali-toolkit/public-api/controls/table-view/table-view.h b/dali-toolkit/public-api/controls/table-view/table-view.h index be37f50..fb7dd53 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -383,7 +383,7 @@ public: void SetFitHeight( unsigned int rowIndex ); /** - * @brief Is the row a fit row + * @brief Check if the row is a fit row. * * @SINCE_1_0.0 * @param[in] rowIndex The row to check @@ -400,7 +400,7 @@ public: void SetFitWidth( unsigned int columnIndex ); /** - * @brief Is the column a fit column + * @brief Check if the column is a fit column. * * @SINCE_1_0.0 * @param[in] columnIndex The column to check diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index 70bddb0..dd8da9b 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -42,7 +42,7 @@ namespace ControlOrientation { /** - * @brief The internal orientation of a control. + * @brief Enumeration for the internal orientation of a control. * @SINCE_1_0.0 */ enum Type @@ -59,7 +59,7 @@ enum Type * @brief Query whether an orientation is vertical. * * @param[in] orientation The orientation. - * @return True if the orientation is vertical. + * @return true if the orientation is vertical. */ DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation); @@ -68,7 +68,7 @@ DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation); * * @SINCE_1_0.0 * @param[in] orientation The orientation. - * @return True if the orientation is horizontal. + * @return true if the orientation is horizontal. */ DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation); -- 2.7.4