doc/dali-adaptor-doc.h

   1 #ifndef DALI_ADAPTOR_DOC_H
   2 #define DALI_ADAPTOR_DOC_H
   3
   4 /*
   5  * Copyright (c) 2021 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_adaptor DALi Adaptor
  23  *
  24  * @brief DALi Adaptor is a platform adaptation layer.
  25  *
  26  * It initializes and sets up DALi appropriately and
  27  * provides many platform-related services with its internal module,
  28  * platform abstraction. Several signals can be connected to it to keep you informed when
  29  * certain platform-related activities occur.
  30  *
  31  * @section dali_adaptor_overview Overview
  32  *
  33  * DALi Adaptor consists of the following groups of API:
  34  *
  35  * <table>
  36  * <tr>
  37  *    <th>API Group</th>
  38  *    <th>Description</th>
  39  * </tr>
  40  * <tr>
  41  *    <td>@ref dali_adaptor_framework</td>
  42  *    <td>Classes for the adaption layer.</td>
  43  * </tr>
  44  * </table>
  45  *
  46  * \ifnot show_tizen_feature
  47  *
  48  * @section dali_toolkit_feature Related Features
  49  * This API is related with the following features:\n
  50  *    - http://tizen.org/feature/opengles.version.2_0\n
  51  *
  52  * It is recommended to design feature related codes in your application for reliability.\n
  53  *
  54  * 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
  55  *
  56  * 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
  57  *
  58  * 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>
  59  *
  60  * \endif
  61  *
  62  * @ingroup dali
  63  * @{
  64  *   @defgroup dali_adaptor_framework Adaptor Framework
  65  *   @brief Classes for the adaption layer.
  66  * @}
  67  */
  68
  69 #endif /* DALI_ADAPTOR_DOC_H */