Merge "Fix invalid update to TextUpdateInfo in SELECTING state." into devel/master

[platform/core/uifw/dali-toolkit.git] / doc / dali-toolkit-doc.h

diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h
old mode 100644 (file)
new mode 100755 (executable)
index 87b49b5..ce364eb
--- a/doc/dali-toolkit-doc.h
+++ b/doc/dali-toolkit-doc.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_DOC_H__
-#define __DALI_TOOLKIT_DOC_H__
+#ifndef DALI_TOOLKIT_DOC_H
+#define DALI_TOOLKIT_DOC_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -59,7 +59,7 @@
  *
  * @brief DALi Toolkit provides UI components and various effects on top of the DALi Core.
  *
- * @section dali_core_overview Overview
+ * @section dali_toolkit_overview Overview
  *
  * DALi Toolkit consists of the following groups of API:
  *
@@ -86,15 +86,19 @@
  * </tr>
  * <tr>
  *    <td style="padding-left:1em">@ref dali_toolkit_controls_image_view</td>
- *    <td>ImageView is a control displying an image.</td>
+ *    <td>ImageView is a control displaying an image.</td>
+ * </tr>
+ * <tr>
+ *    <td style="padding-left:1em">@ref dali_toolkit_controls_model3d_view</td>
+ *    <td>Model3dView is a control for displaying 3d geometry.</td>
  * </tr>
  * <tr>
  *    <td style="padding-left:1em">@ref dali_toolkit_controls_scroll_bar</td>
- *    <td>ScrollBar control.</td>
+ *    <td>ScrollBar is a component that can be linked to the scrollable objects.</td>
  * </tr>
  * <tr>
  *    <td style="padding-left:1em">@ref dali_toolkit_controls_scrollable</td>
- *    <td>Scrollable container controls.</td>
+ *    <td>Scrollable contains scrolled controls.</td>
  * </tr>
  * <tr>
  *    <td style="padding-left:2em">@ref dali_toolkit_controls_item_view</td>
@@ -125,11 +129,39 @@
  *    <td>Slider is a control to enable sliding an indicator between two values.</td>
  * </tr>
  * <tr>
+ *    <td style="padding-left:1em">@ref dali_toolkit_controls_progress_bar</td>
+ *    <td>ProgressBar is a control to give the user an indication of the progress of an operation.</td>
+ * </tr>
+ * <tr>
  *    <td>@ref dali_toolkit_managers</td>
  *    <td>Singleton classes for managing application-wide functionalities.</td>
  * </tr>
+ * <tr>
+ *    <td>@ref dali_toolkit_visuals</td>
+ *    <td>Visuals can control rendering the contents as using Property.</td>
+ * </tr>
+ * <tr>
+ *    <td>@ref dali_toolkit_image_loader</td>
+ *    <td>The ImageLoader is used to load pixel data from a URL.</td>
+ * </tr>
  * </table>
  *
+ * \ifnot show_tizen_feature
+ *
+ * @section dali_toolkit_feature Related Features
+ * This API is related with the following features:\n
+ *    - http://tizen.org/feature/opengles.version.2_0\n
+ *
+ * It is recommended to design feature related codes in your application for reliability.\n
+ *
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ *
+ * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
+ *
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
+ *
+ * \endif
+ *
  * @ingroup dali
  * @{
  *   @defgroup dali_toolkit_controls Controls
@@ -142,17 +174,23 @@
  *     @defgroup dali_toolkit_controls_buttons Buttons
  *     @brief Button is a small object on UI that you can press.
 
+ *     @defgroup dali_toolkit_controls_canvas_view CanvasView
+ *     @brief CanvasView is a class for displaying an vector primitives.
+ *
  *     @defgroup dali_toolkit_controls_gaussian_blur_view Gaussian Blur View
  *     @brief GaussianBlurView provides a render process that blurs an image.
 
  *     @defgroup dali_toolkit_controls_image_view Image View
- *     @brief ImageView is a control displying an image.
+ *     @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 control.
+ *     @brief ScrollBar is a component that can be linked to the scrollable objects.
 
  *     @defgroup dali_toolkit_controls_scrollable Scrollable
- *     @brief Scrollable container controls.
+ *     @brief Scrollable contains scrolled controls.
 
  *     @{
  *       @defgroup dali_toolkit_controls_item_view Item View
@@ -177,13 +215,21 @@
  *     @defgroup dali_toolkit_controls_slider Slider
  *     @brief Slider is a control to enable sliding an indicator between two values.
 
+ *     @defgroup dali_toolkit_controls_progress_bar Progress Bar
+ *     @brief ProgressBar is a control to give the user an indication of the progress of an operation.
+
  *   @}
 
  *   @defgroup dali_toolkit_managers Managers
  *   @brief Singleton classes for managing application-wide functionalities.
 
+ *   @defgroup dali_toolkit_visuals Visuals
+ *   @brief Visuals can control rendering the contents as using Property.
+
+ *   @defgroup dali_toolkit_image_loader Image Loader
+ *   @brief The ImageLoader is used to load pixel data from a URL.
+
  * @}
  */
 
-
-#endif  /* __DALI_TOOLKIT_DOC_H__ */
+#endif // DALI_TOOLKIT_DOC_H