Add doc files for API references
[platform/core/appfw/message-port.git] / doc / message-port-doc.h
1 /*
2  * Copyright (c) 2014 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 #ifndef __TIZEN_APPFW_MESSAGE_PORT_DOC_H__
18 #define __TIZEN_APPFW_MESSAGE_PORT_DOC_H__
19
20 /**
21  * @ingroup CAPI_APPLICATION_FRAMEWORK
22  * @defgroup CAPI_MESSAGE_PORT_MODULE Message Port
23  * @brief The @ref CAPI_MESSAGE_PORT_MODULE API provides functions to send and receive messages between applications.
24  *
25  * @section CAPI_MESSAGE_PORT_MODULE_HEADER Required Header
26  *   \#include <message_port.h>
27  *
28  * @section CAPI_MESSAGE_PORT_MODULE_OVERVIEW Overview
29  * The @ref CAPI_MESSAGE_PORT_MODULE API provides functions for passing messages between applications.
30  * An application should register its own local port to receive messages from remote applications.
31  * If a remote application sends a message, the registered callback function of the local port is called. @n
32  * The trusted message-port API allows communications between applications that are signed by the same developer (author) certificate. 
33 */
34
35 #endif /* __TIZEN_APPFW_MESSAGE_PORT_DOC_H__ */