From b94c342bb7bde521c6a31eec1b807bed48a8f7e6 Mon Sep 17 00:00:00 2001 From: Jiwon Kim Date: Thu, 3 Mar 2016 11:02:06 +0900 Subject: [PATCH] Add document about API reference Change-Id: Idac8ac648f2c34161db3b881599f20b9e2dbab77 Signed-off-by: Jiwon Kim --- doc/service_adaptor_doc.h | 46 ++++++++++++++++++++++++++++++++++++++ doc/service_adaptor_plugin_doc.h | 45 +++++++++++++++++++++++++++++++++++++ doc/service_adaptor_storage_doc.h | 47 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 138 insertions(+) create mode 100644 doc/service_adaptor_doc.h create mode 100644 doc/service_adaptor_plugin_doc.h create mode 100644 doc/service_adaptor_storage_doc.h diff --git a/doc/service_adaptor_doc.h b/doc/service_adaptor_doc.h new file mode 100644 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 + * @section SERVICE_ADAPTOR_MODULE_OVERVIEW Overview + * Developers can use functions easily and commonly be provided from various service infra. + *
When you want use another service infra, you can use same interfaces if you change just initalize setting. + *
Service adaptor provides functions kind of Auth, Storage and it will provides more kinds of service infra. + * + * + * + * + * + * + * + * + * + *
APIDescription
@ref SERVICE_PLUGIN_MODULE Provide functions for handling service plugin
+ * \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 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 plugin set's property and state + * + * @section SERVICE_PLUGIN_MODULE_HEADER Required Header + * \#include + * @section SERVICE_PLUGIN_MODULE_OVERVIEW Overview + * The #service_plugin_h can gets using @ref SERVICE_ADAPTOR_MODULE API. + *
It means kind of plugin set, the APIs can set property for using service and handling service plugin. + * + * + * + * + * + * + * + * + * + *
APIDescription
@ref SERVICE_ADAPTOR_STORAGE_MODULE Provide functions for access and manage storage service
+ * \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 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 + * @section SERVICE_ADAPTOR_STORAGE_MODULE_OVERVIEW Overview + * It privides common APIs for using various service infra + *
+ * In this APIs, there are needed two kind of path types. + * One is "Logical path" and the other is "Physical path".
+ *
+ *

First, "Logical path" type means path of "root file system".
+ * It starts from root path(= '/') and you can use this path like linux.
+ * For example, "/folder1/image1.jpg"

+ *

+ *
+ *

Second, "Physical path" type means specfic uri that be used for cloud server.
+ * Some clouds use same with "Logical path", but some clouds use specfic key or url.
+ * For example, "/" is "ZmNhMWY2MTZlY2M1NDg4OGJmZDY4O", "/folder1" is "2JI32UNJDWQEQWQWEADSSAD"
+ *

+ * Under the @ref SERVICE_ADAPTOR_STORAGE_MODULE APIs, the path parameters are used these types.
+ *
+ */ + + +#endif /*__TIZEN_SOCIAL_SERVICE_ADAPTOR_STORAGE_DOC_H__*/ -- 2.7.4