doc/dali-core-doc.h

   1 #ifndef __DALI_DOC_H__
   2 #define __DALI_DOC_H__
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 /**
  22  * @defgroup dali_core DALi Core
  23  *
  24  * @brief DALi Core provides core functionalities such as scene graph-based rendering, animation, and event handling.
  25  *
  26  * It is a base module and forms the biggest part of DALi.
  27  *
  28  * @section dali_core_overview Overview
  29  *
  30  * DALi Core consists of the following groups of API:
  31  *
  32  * <table>
  33  * <tr>
  34  *    <th>API Group</th>
  35  *    <th>Description</th>
  36  * </tr>
  37  * <tr>
  38  *    <td>@ref dali_core_actors</td>
  39  *    <td>Actor is the primary object for interaction in DALi applications.</td>
  40  * </tr>
  41  * <tr>
  42  *    <td>@ref dali_core_animation</td>
  43  *    <td>Classes for animation which allows your objects to move around / change their properties for a specified duration.</td>
  44  * </tr>
  45  * <tr>
  46  *    <td>@ref dali_core_common</td>
  47  *    <td>Common classes for using DALi.</td>
  48  * </tr>
  49  * <tr>
  50  *    <td>@ref dali_core_events</td>
  51  *    <td>Classes for input events and gestures supported by DALi.</td>
  52  * </tr>
  53  * <tr>
  54  *    <td>@ref dali_core_images</td>
  55  *    <td>Classes for handling images.</td>
  56  * </tr>
  57  * <tr>
  58  *    <td>@ref dali_core_math</td>
  59  *    <td>Classes for basic math.</td>
  60  * </tr>
  61  * <tr>
  62  *    <td>@ref dali_core_object</td>
  63  *    <td>Classes for the handle/body pattern and property system.</td>
  64  * </tr>
  65  * <tr>
  66  *    <td>@ref dali_core_rendering_effects</td>
  67  *    <td>Classes for render task and shader effect.</td>
  68  * </tr>
  69  * <tr>
  70  *    <td>@ref dali_core_signals</td>
  71  *    <td>Classes for the signal and slot structure.</td>
  72  * </tr>
  73  * </table>
  74  *
  75  * \ifnot show_tizen_feature
  76  *
  77  * @section dali_toolkit_feature Related Features
  78  * This API is related with the following features:\n
  79  *    - http://tizen.org/feature/opengles.version.2_0\n
  80  *
  81  * It is recommended to design feature related codes in your application for reliability.\n
  82  *
  83  * 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
  84  *
  85  * 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
  86  *
  87  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  88  *
  89  * \endif
  90  *
  91  * @ingroup dali
  92  * @{
  93  *   @defgroup dali_core_actors Actors
  94  *   @brief Actor is the primary object for interaction in DALi applications.
  95
  96  *   @defgroup dali_core_animation Animation
  97  *   @brief Classes for animation which allows your objects to move around / change their properties for a specified duration.
  98
  99  *   @defgroup dali_core_common Common
 100  *   @brief Common classes for using DALi.
 101
 102  *   @defgroup dali_core_events Events
 103  *   @brief Classes for input events and gestures supported by DALi.
 104
 105  *   @defgroup dali_core_images Images
 106  *   @brief Classes for handling resource images.
 107
 108  *   @defgroup dali_core_math Math
 109  *   @brief Classes for basic math.
 110
 111  *   @defgroup dali_core_object Object
 112  *   @brief Classes for the handle/body pattern and property system.
 113
 114  *   @defgroup dali_core_rendering_effects Rendering & Effect
 115  *   @brief Classes for render task and shader effect.
 116
 117  *   @defgroup dali_core_signals Signal
 118  *   @brief Classes for the signal and slot structure.
 119  * @}
 120  */
 121
 122 #endif  /* __DALI_DOC_H__ */