Add doc files for API references
[platform/core/appfw/ui-gadget-1.git] / doc / ui-gadget_doc.h
1 /*
2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 #ifndef __TIZEN_CORE_LIB_UI_GADGET_DOC_H__
19 #define __TIZEN_CORE_LIB_UI_GADGET_DOC_H__
20
21 /**
22  * @defgroup CORE_LIB_GROUP_UI_GADGET_MODULE UI Gadget
23  * @brief  The UI gadget is a visual component providing views(or features) of other applications.
24  * @ingroup CAPI_APPLICATION_FRAMEWORK
25  *
26  * @section CORE_LIB_GROUP_UI_GADGET_MODULE_HEADER Required Header
27  *   \#include <ui-gadget.h>
28  *
29  * @section CORE_LIB_GROUP_UI_GADGET_MODULE_OVERVIEW Overview
30  * The UI gadget is a visual component providing views(or features) of other applications.
31  * Because UI gadgets are supposed to deliver most commonly used features that the platform can natively support,
32  * developers can avoid unnecessary massive code writing using UI gadgets.
33  * Hence an UI gadget eventually includes logics to handle simple request.
34  * UI gadget is able to be managed by UI gadget library
35  */
36
37 /**
38  * @defgroup CORE_LIB_GROUP_UI_GADGET_MODULE_MODULE UI Gadget Module
39  * @brief
40  * @ingroup CORE_LIB_GROUP_UI_GADGET_MODULE
41  *
42  * @section CORE_LIB_GROUP_UI_GADGET_MODULE_MODULE_HEADER Required Header
43  *   \#include <ui-gadget-module.h>
44  */
45
46 #endif /* __TIZEN_CORE_LIB_UI_GADGET_DOC_H__ */