X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fdali-core-doc.h;h=d1049063ff040ad3a234767fc14d527a3cf0376b;hb=165d2693f548767b8a264f9297f76e305c2bb685;hp=82ebbec4fd4f597cf6cf63b6cdb4a8c35d756a3c;hpb=07d00b695a47b884599de3a9aaf36eba21a3f827;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/doc/dali-core-doc.h b/doc/dali-core-doc.h index 82ebbec..d104906 100644 --- a/doc/dali-core-doc.h +++ b/doc/dali-core-doc.h @@ -1,44 +1,129 @@ -#ifndef __DALI_DOC_H__ -#define __DALI_DOC_H__ +#ifndef DALI_DOC_H +#define DALI_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_core DALi Core - * @ingroup dali * - * @brief This module provides scene graph-based rendering, animation, and event handling. + * @brief DALi Core provides core functionalities such as scene graph-based rendering, animation, and event handling. + * * It is a base module and forms the biggest part of DALi. * + * @section dali_core_overview Overview + * + * DALi Core consists of the following groups of API: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
API GroupDescription
@ref dali_core_actorsActor is the primary object for interaction in DALi applications.
@ref dali_core_animationClasses for animation which allows your objects to move around / change their properties for a specified duration.
@ref dali_core_commonCommon classes for using DALi.
@ref dali_core_eventsClasses for input events and gestures supported by DALi.
@ref dali_core_imagesClasses for handling images.
@ref dali_core_mathClasses for basic math.
@ref dali_core_objectClasses for the handle/body pattern and property system.
@ref dali_core_rendering_effectsClasses for render task and shader effect.
@ref dali_core_signalsClasses for the signal and slot structure.
@ref dali_core_size_negotiationClasses for the size negotiation.
+ * + * \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 Feature Element. + * + * \endif + * + * @ingroup dali * @{ * @defgroup dali_core_actors Actors * @brief Actor is the primary object for interaction in DALi applications. * @defgroup dali_core_animation Animation - * @brief Animation allows your objects to move around / change their properties for a specified duration. + * @brief Classes for animation which allows your objects to move around / change their properties for a specified duration. * @defgroup dali_core_common Common * @brief Common classes for using DALi. * @defgroup dali_core_events Events - * @brief Input events and gestures supported by DALi. + * @brief Classes for input events and gestures supported by DALi. * @defgroup dali_core_images Images * @brief Classes for handling resource images. * @defgroup dali_core_math Math - * @brief Basic math classes. + * @brief Classes for basic math. * @defgroup dali_core_object Object * @brief Classes for the handle/body pattern and property system. - * @defgroup dali_core_render_tasks Render Tasks - * @brief Render task classes. + * @defgroup dali_core_rendering_effects Rendering & Effect + * @brief Classes for render task and shader effect. - * @defgroup dali_core_shader_effects Shader Effects - * @brief Shader effect classes. - - * @defgroup dali_core_signals Signals + * @defgroup dali_core_signals Signal * @brief Classes for the signal and slot structure. + + * @defgroup dali_core_size_negotiation Size Negotiation + * @brief Classes for the size negotiation. * @} */ -#endif /* __DALI_DOC_H__ */ +#endif /* DALI_DOC_H */