X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fdali-toolkit-doc.h;h=ce364ebaebf9728b10d720ffc09da030212c215d;hb=2d59f0b716ea7f7c06de0732d3e4e78aea127de6;hp=2cb0f1ad80474974d03941a57f32e664886e82d5;hpb=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git
diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h
old mode 100644
new mode 100755
index 2cb0f1a..ce364eb
--- a/doc/dali-toolkit-doc.h
+++ b/doc/dali-toolkit-doc.h
@@ -1,5 +1,22 @@
-#ifndef __DALI_TOOLKIT_DOC_H__
-#define __DALI_TOOLKIT_DOC_H__
+#ifndef DALI_TOOLKIT_DOC_H
+#define DALI_TOOLKIT_DOC_H
+
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
/**
* @defgroup dali DALi
@@ -8,68 +25,211 @@
* @brief DALi is a cross-platform 3D UI Toolkit for embedded systems.
*
* @section dali-overview Overview
+ *
* DALi's 3D user interface engine enables you to create rich and high-performance
* UI applications. DALi is based on OpenGL ES 2.0, but provides a clean
* cross-platform C++ framework.
* This means that you can use high-level DALi APIs instead of accessing
* low-level OpenGL APIs directly.
- *
+ *
+ * API Group |
+ * Description |
+ *
+ *
+ * @ref dali_toolkit_controls |
+ * Controls are interactive components for layouting the user interface. |
+ *
+ *
+ * @ref dali_toolkit_controls_alignment |
+ * Alignment is a container which provides an easy way to align other actors inside its boundary. |
+ *
+ *
+ * @ref dali_toolkit_controls_buttons |
+ * Button is a small object on UI that you can press. |
+ *
+ *
+ * @ref dali_toolkit_controls_gaussian_blur_view |
+ * GaussianBlurView provides a render process that blurs an image. |
+ *
+ *
+ * @ref dali_toolkit_controls_image_view |
+ * 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. |
+ *
+ *
+ * @ref dali_toolkit_controls_scrollable |
+ * Scrollable contains scrolled controls. |
+ *
+ *
+ * @ref dali_toolkit_controls_item_view |
+ * ItemView class is a scrollable container that can contain many items. |
+ *
+ *
+ * @ref dali_toolkit_controls_scroll_view |
+ * ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. |
+ *
+ *
+ * @ref dali_toolkit_controls_table_view |
+ * TableView class is a layout container for aligning child actors in a grid like layout. |
+ *
+ *
+ * @ref dali_toolkit_controls_text_controls |
+ * Controls for displaying text or text input. |
+ *
+ *
+ * @ref dali_toolkit_controls_flex_container |
+ * FlexContainer is a container for Flexbox layout. |
+ *
+ *
+ * @ref dali_toolkit_controls_video_view |
+ * VideoView is a control for video playback and display. |
+ *
+ *
+ * @ref dali_toolkit_controls_slider |
+ * Slider is a control to enable sliding an indicator between two values. |
+ *
+ *
+ * @ref dali_toolkit_controls_progress_bar |
+ * ProgressBar is a control to give the user an indication of the progress of an operation. |
+ *
+ *
+ * @ref dali_toolkit_managers |
+ * Singleton classes for managing application-wide functionalities. |
+ *
+ *
+ * @ref dali_toolkit_visuals |
+ * Visuals can control rendering the contents as using Property. |
+ *
+ *
+ * @ref dali_toolkit_image_loader |
+ * The ImageLoader is used to load pixel data from a URL. |
+ *
+ *
+ *
+ * \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
*
- * @brief This module provides UI components and various effects on top of the dali-core.
+ * 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