From 3257f4a57ff88013c5f4dc4c01b863ab0f79e763 Mon Sep 17 00:00:00 2001 From: Joogab Yun Date: Mon, 2 Apr 2018 08:43:24 +0900 Subject: [PATCH] add doc for API reference Change-Id: I7b11790c7d352bdfe2de00fc3e05bfce9586e62a --- .../public-api/controls/model3d-view/model3d-view.h | 19 ++++++++++++++++--- .../controls/scrollable/scroll-view/scroll-view.h | 5 ++++- dali-toolkit/public-api/text/rendering-backend.h | 5 ++++- doc/dali-toolkit-doc.h | 7 +++++++ 4 files changed, 31 insertions(+), 5 deletions(-) mode change 100644 => 100755 dali-toolkit/public-api/controls/model3d-view/model3d-view.h mode change 100644 => 100755 dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h mode change 100644 => 100755 dali-toolkit/public-api/text/rendering-backend.h mode change 100644 => 100755 doc/dali-toolkit-doc.h diff --git a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h old mode 100644 new mode 100755 index ac7c1b0..9ef0d46 --- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h +++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h @@ -31,6 +31,12 @@ namespace Internal DALI_INTERNAL { class Model3dView; } + +/** + * @addtogroup dali_toolkit_controls_model3d_view + * @{ + */ + /** * @brief Model3dView is a control for displaying 3d geometry. * @@ -80,11 +86,15 @@ public: }; }; + /** + * @brief Enumeration for the type of illumination. + * @SINCE_1_1.4 + */ enum IlluminationType { - DIFFUSE, - DIFFUSE_WITH_TEXTURE, - DIFFUSE_WITH_NORMAL_MAP + DIFFUSE, ///< diffuse @SINCE_1_1.4 + DIFFUSE_WITH_TEXTURE, ///< diffuse with texture @SINCE_1_1.4 + DIFFUSE_WITH_NORMAL_MAP ///< diffuse with normal map @SINCE_1_1.4 }; /** @@ -173,6 +183,9 @@ public: // Not intended for application developers }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali 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 old mode 100644 new mode 100755 index 646f397..594e6da --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -157,7 +157,10 @@ class RulerExtension; class DALI_IMPORT_API Ruler : public RefObject { public: - /// @brief The type of the ruler + /** + * @brief Enumeration for the type of the ruler. + * @SINCE_1_0.0 + */ enum RulerType { Fixed, ///< A fixed ruler @SINCE_1_0.0 Free ///< A free ruler @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/text/rendering-backend.h b/dali-toolkit/public-api/text/rendering-backend.h old mode 100644 new mode 100755 index 97abfb8..00686ed --- a/dali-toolkit/public-api/text/rendering-backend.h +++ b/dali-toolkit/public-api/text/rendering-backend.h @@ -27,7 +27,10 @@ namespace Toolkit namespace Text { -// The type of text renderer required +/** + * @brief Enumeration for the type of text renderer required. + * @SINCE_1_0.0 + */ enum RenderingType { RENDERING_SHARED_ATLAS, ///< A bitmap-based solution where renderers can share a texture atlas @SINCE_1_0.0 diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h old mode 100644 new mode 100755 index bc706fb..813d2ac --- a/doc/dali-toolkit-doc.h +++ b/doc/dali-toolkit-doc.h @@ -89,6 +89,10 @@ * ImageView is a control displaying an image. * * + * @ref dali_toolkit_controls_model3d_view + * Model3dView is a control for displaying 3d geometry. + * + * * @ref dali_toolkit_controls_scroll_bar * ScrollBar is a component that can be linked to the scrollable objects. * @@ -172,6 +176,9 @@ * @defgroup dali_toolkit_controls_image_view Image View * @brief ImageView is a control displaying an image. + * @defgroup dali_toolkit_controls_model3d_view Model3dView + * @brief Model3dView is a control for displaying 3d geometry. + * @defgroup dali_toolkit_controls_scroll_bar Scroll Bar * @brief ScrollBar is a component that can be linked to the scrollable objects. -- 2.7.4