Add document about API reference

Change-Id: Idac8ac648f2c34161db3b881599f20b9e2dbab77
Signed-off-by: Jiwon Kim <jiwon177.kim@samsung.com>

diff --git a/doc/service_adaptor_doc.h b/doc/service_adaptor_doc.h
new file mode 100644 (file)
index 0000000..f0c27ac
--- /dev/null
+++ b/doc/service_adaptor_doc.h
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * 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.
+ */
+
+#ifndef __TIZEN_SOCIAL_SERVICE_ADAPTOR_MODULE_DOC_H__
+#define __TIZEN_SOCIAL_SERVICE_ADAPTOR_MODULE_DOC_H__
+
+
+/**
+ * @ingroup    CAPI_SOCIAL_FRAMEWORK
+ * @defgroup   SERVICE_ADAPTOR_MODULE Service Adaptor
+ * @brief      The @ref SERVICE_ADAPTOR_MODULE API provides developer with common interfaces like using local service for various service infra.
+ *
+ * @section    SERVICE_ADAPTOR_MODULE_HEADER Required Header
+ *  \#include <service_adaptor_client.h>
+ * @section    SERVICE_ADAPTOR_MODULE_OVERVIEW Overview
+ * Developers can use functions easily and commonly be provided from various service infra.
+ * <br>When you want use another service infra, you can use same interfaces if you change just initalize setting.
+ * <br>Service adaptor provides functions kind of Auth, Storage and it will provides more kinds of service infra.
+ * <table>
+ * <tr>
+ *     <th>API</th>
+ *     <th>Description</th>
+ * </tr>
+ * <tr>
+ *     <td>@ref SERVICE_PLUGIN_MODULE</td>
+ *     <td> Provide functions for handling service plugin</td>
+ * </tr>
+ * </table>
+ * \n
+ */
+
+
+#endif /*__TIZEN_SOCIAL_SERVICE_ADAPTOR_MODULE_DOC_H__*/

diff --git a/doc/service_adaptor_plugin_doc.h b/doc/service_adaptor_plugin_doc.h
new file mode 100644 (file)
index 0000000..a9a0485
--- /dev/null
+++ b/doc/service_adaptor_plugin_doc.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * 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.
+ */
+
+#ifndef __TIZEN_SOCIAL_SERVICE_PLUGIN_MODULE_DOC_H__
+#define __TIZEN_SOCIAL_SERVICE_PLUGIN_MODULE_DOC_H__
+
+
+/**
+ * @ingroup    SERVICE_ADAPTOR_MODULE
+ * @defgroup   SERVICE_PLUGIN_MODULE Service Plugin
+ * @brief      The @ref SERVICE_PLUGIN_MODULE API provides functions to manage the <b>plugin set</b>'s property and state
+ *
+ * @section    SERVICE_PLUGIN_MODULE_HEADER Required Header
+ *  \#include <service_adaptor_client.h>
+ * @section    SERVICE_PLUGIN_MODULE_OVERVIEW Overview
+ * The #service_plugin_h can gets using @ref SERVICE_ADAPTOR_MODULE API.
+ * <br>It means kind of plugin set, the APIs can set property for using service and handling service plugin.
+ * <table>
+ * <tr>
+ *     <th>API</th>
+ *     <th>Description</th>
+ * </tr>
+ * <tr>
+ *     <td>@ref SERVICE_ADAPTOR_STORAGE_MODULE</td>
+ *     <td> Provide functions for access and manage storage service</td>
+ * </tr>
+ * </table>
+ * \n
+ */
+
+
+#endif /*__TIZEN_SOCIAL_SERVICE_PLUGIN_MODULE_DOC_H__*/

diff --git a/doc/service_adaptor_storage_doc.h b/doc/service_adaptor_storage_doc.h
new file mode 100644 (file)
index 0000000..8d1c7a3
--- /dev/null
+++ b/doc/service_adaptor_storage_doc.h
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * 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.
+ */
+
+#ifndef __TIZEN_SOCIAL_SERVICE_ADAPTOR_STORAGE_DOC_H__
+#define __TIZEN_SOCIAL_SERVICE_ADAPTOR_STORAGE_DOC_H__
+
+
+/**
+ * @ingroup    SERVICE_PLUGIN_MODULE
+ * @defgroup   SERVICE_ADAPTOR_STORAGE_MODULE Storage
+ * @brief      Provide functions for access and managing storage service
+ * @section    SERVICE_ADAPTOR_STORAGE_MODULE_HEADER Require Header
+ * \#include <service_adaptor_client.h>
+ * @section    SERVICE_ADAPTOR_STORAGE_MODULE_OVERVIEW Overview
+ * It privides common APIs for using various service infra
+ * <div>
+ * In this APIs, there are needed two kind of path types.
+ * One is <b>"Logical path"</b> and the other is <b>"Physical path"</b>.<br>
+ * <div>
+ * <p>First, <b>"Logical path"</b> type means path of "root file system".<br>
+ * It starts from root path(= '/') and you can use this path like linux.<br>
+ * For example, "/folder1/image1.jpg"<br><br>
+ * </div>
+ * <div>
+ * <p>Second, <b>"Physical path"</b> type means specfic uri that be used for cloud server.<br>
+ * Some clouds use same with "Logical path", but some clouds use specfic key or url.<br>
+ * For example, "/" is "ZmNhMWY2MTZlY2M1NDg4OGJmZDY4O", "/folder1" is "2JI32UNJDWQEQWQWEADSSAD"<br>
+ * </div>
+ * Under the @ref SERVICE_ADAPTOR_STORAGE_MODULE APIs, the path parameters are used these types.<br>
+ * </div>
+ */
+
+
+#endif /*__TIZEN_SOCIAL_SERVICE_ADAPTOR_STORAGE_DOC_H__*/