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 Group | + *Description | + *
---|---|
@ref dali_core_actors | + *Actor is the primary object for interaction in DALi applications. | + *
@ref dali_core_animation | + *Classes for animation which allows your objects to move around / change their properties for a specified duration. | + *
@ref dali_core_common | + *Common classes for using DALi. | + *
@ref dali_core_events | + *Classes for input events and gestures supported by DALi. | + *
@ref dali_core_images | + *Classes for handling images. | + *
@ref dali_core_math | + *Classes for basic math. | + *
@ref dali_core_object | + *Classes for the handle/body pattern and property system. | + *
@ref dali_core_rendering_effects | + *Classes for render task and shader effect. | + *
@ref dali_core_signals | + *Classes for the signal and slot structure. | + *
@ref dali_core_size_negotiation | + *Classes for the size negotiation. | + *