add doc directory and document headers

Change-Id: Ib460337c9992cedb3c8201719e593665b9a3f5f7
Signed-off-by: Dongsun Lee <ds73.lee@samsung.com>

diff --git a/doc/csr-framework-admin_doc.h b/doc/csr-framework-admin_doc.h
new file mode 100644 (file)
index 0000000..2ca1332
--- /dev/null
+++ b/doc/csr-framework-admin_doc.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2016 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_CORE_CSR_FRAMEWORK_ADMIN_DOC_H__
+#define __TIZEN_CORE_CSR_FRAMEWORK_ADMIN_DOC_H__
+/**
+ * @ingroup CAPI_CSR_FRAMEWORK_MODULE
+ * @defgroup CAPI_CSR_FRAMEWORK_ADMIN_MODULE Admin Module
+ * @brief    It provides APIs managing underlying anti malware engines.
+ *
+ * @section CAPI_CSR_FRAMEWORK_ADMIN_MODULE_HEADER Required Header
+ * \#include <csr-engine-manager.h>
+ *
+ * @section CAPI_CSR_FRAMEWORK_ADMIN_MODULE_OVERVIEW Overview
+ * It provides APIs getting engine information and enabling or disabling underlying anti malware engines.
+ */
+
+#endif /* __TIZEN_CORE_CSR_FRAMEWORK_ADMIN_DOC_H__ */

diff --git a/doc/csr-framework-cs_doc.h b/doc/csr-framework-cs_doc.h
new file mode 100644 (file)
index 0000000..e36084c
--- /dev/null
+++ b/doc/csr-framework-cs_doc.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2016 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_CORE_CSR_FRAMEWORK_CS_DOC_H__
+#define __TIZEN_CORE_CSR_FRAMEWORK_CS_DOC_H__
+/**
+ * @ingroup CAPI_CSR_FRAMEWORK_MODULE
+ * @defgroup CAPI_CSR_FRAMEWORK_CS_MODULE Content Screening Module
+ * @brief    It provides APIs scanning contents for data, files, and directories to detect malwares.
+ *
+ * @section CAPI_CSR_FRAMEWORK_CS_MODULE_HEADER Required Header
+ * \#include <csr-content-screening.h>
+ *
+ * @section CAPI_CSR_FRAMEWORK_CS_MODULE_OVERVIEW Overview
+ * It provides APIs scanning contents for data, files, and directories to detect malwares. Actual scanning is performed by underlying anti malware engines which will be provided by a device manufacturer.
+ */
+
+#endif /* __TIZEN_CORE_CSR_FRAMEWORK_CS_DOC_H__ */

diff --git a/doc/csr-framework-types_doc.h b/doc/csr-framework-types_doc.h
new file mode 100644 (file)
index 0000000..f88583a
--- /dev/null
+++ b/doc/csr-framework-types_doc.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2016 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_CORE_CSR_FRAMEWORK_TYPES_DOC_H__
+#define __TIZEN_CORE_CSR_FRAMEWORK_TYPES_DOC_H__
+/**
+ * @ingroup CAPI_CSR_FRAMEWORK_MODULE
+ * @defgroup CAPI_CSR_FRAMEWORK_TYPES_MODULE Data Types
+ * @brief    It defines data types used in these APIs and provides utility methods handling them.
+ *
+ * @section CAPI_CSR_FRAMEWORK_TYPES_MODULE_HEADER Required Header
+ * \#include <csr-content-screening-types.h>
+ * \#include <csr-web-protection-types.h>
+ * \#include <csr-error.h>
+ *
+ * @section CAPI_CSR_FRAMEWORK_TYPES_MODULE_OVERVIEW Overview
+ * It defines data types used in these APIs and provides utility methods handling them.
+ *
+ */
+
+#endif /* __TIZEN_CORE_CSR_FRAMEWORK_TYPES_DOC_H__ */

diff --git a/doc/csr-framework-wp_doc.h b/doc/csr-framework-wp_doc.h
new file mode 100644 (file)
index 0000000..1a9ea98
--- /dev/null
+++ b/doc/csr-framework-wp_doc.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2016 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_CORE_CSR_FRAMEWORK_WP_DOC_H__
+#define __TIZEN_CORE_CSR_FRAMEWORK_WP_DOC_H__
+/**
+ * @ingroup CAPI_CSR_FRAMEWORK_MODULE
+ * @defgroup CAPI_CSR_FRAMEWORK_WP_MODULE Web Protection Module
+ * @brief    It provides provides APIs checking URL reputation to see if the URL is risky or not.
+ *
+ * @section CAPI_CSR_FRAMEWORK_WP_MODULE_HEADER Required Header
+ * \#include <csr-web-protection.h>
+ *
+ * @section CAPI_CSR_FRAMEWORK_WP_MODULE_OVERVIEW Overview
+ * It provides provides APIs checking URL reputation to see if the URL is risky or not. Actual operation is performed by an underlying anti malware engine which will be provided by a device manufacturer.
+ */
+
+#endif /* __TIZEN_CORE_CSR_FRAMEWORK_WP_DOC_H__ */

diff --git a/doc/csr-framework_doc.h b/doc/csr-framework_doc.h
new file mode 100644 (file)
index 0000000..0e82f5c
--- /dev/null
+++ b/doc/csr-framework_doc.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2016 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_CORE_CSR_FRAMEWORK_DOC_H__
+#define __TIZEN_CORE_CSR_FRAMEWORK_DOC_H__
+/**
+ * @ingroup CAPI_SECURITY_FRAMEWORK
+ * @defgroup CAPI_CSR_FRAMEWORK_MODULE CSR Framework
+ * @brief    The CSR (Content Screening & Reputation) framework is an anti malware framework. It provides Content Screening Service and Web Protection Service to protect a device and an user.
+ *
+ * @section CAPI_CSR_FRAMEWORK_MODULE_OVERVIEW Overview
+ * <table>
+ *   <tr><th>API</th><th>Description</th></tr>
+ *   <tr>
+ *     <td> @ref CAPI_CSR_FRAMEWORK_CS_MODULE</td>
+ *     <td> Provides APIs scanning contents for data, files, and directories to detect malwares.</td>
+ *   </tr>
+ *   <tr>
+ *     <td> @ref CAPI_CSR_FRAMEWORK_WP_MODULE</td>
+ *     <td> Provides APIs checking URL reputation to see if the URL is risky or not.</td>
+ *   </tr>
+ *   <tr>
+ *     <td> @ref CAPI_CSR_FRAMEWORK_ADMIN_MODULE</td>
+ *     <td> Provides APIs managing underlying anti malware engines.</td>
+ *   </tr>
+ *   <tr>
+ *     <td> @ref CAPI_CSR_FRAMEWORK_TYPES_MODULE</td>
+ *     <td> Defines data types used in these APIs and provides utility methods handling them.</td>
+ *   </tr>
+ * </table>
+ *
+ * The CSR (Content Screening & Reputation) framework is an anti malware framework. It provides Content Screening Service and Web Protection Service to protect a device and an user
+ * The Content Screening Service enables caller modules and applications to scan the content for data, files, and directories.
+ * The Web Protection Service enables caller modules and applications to check if a URL they want to access is risky or not.
+ *
+ */
+
+#endif /* __TIZEN_CORE_CSR_FRAMEWORK_DOC_H__ */

diff --git a/src/include/csr/csr-content-screening-types.h b/src/include/csr/csr-content-screening-types.h
index 5a6c06e..68c7842 100644 (file)
--- a/src/include/csr/csr-content-screening-types.h
+++ b/src/include/csr/csr-content-screening-types.h
@@ -27,6 +27,11 @@ extern "C" {
 #endif
 
 /**
+ * @addtogroup CAPI_CSR_FRAMEWORK_TYPES_MODULE
+ * @{
+ */
+
+/**
  * @brief Severity level of a detected malware
  * @since_tizen 3.0
  */
@@ -136,6 +141,10 @@ typedef void (*csr_cs_on_error_cb)(void *user_data, int error_code);
  */
 typedef void (*csr_cs_on_file_scanned_cb)(void *user_data, const char *file_path);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/include/csr/csr-content-screening.h b/src/include/csr/csr-content-screening.h
index 742a6cc..1ace82f 100644 (file)
--- a/src/include/csr/csr-content-screening.h
+++ b/src/include/csr/csr-content-screening.h
@@ -34,6 +34,12 @@ extern "C" {
 #endif
 
 /**
+ * @addtogroup CAPI_CSR_FRAMEWORK_CS_MODULE
+ * @{
+ */
+
+
+/**
  * @brief Initializes and returns a Content Screening API handle.
  *
  * @since_tizen 3.0
@@ -798,6 +804,10 @@ int csr_cs_get_ignored_malwares(csr_cs_context_h handle,
 int csr_cs_dlist_get_detected(csr_cs_detected_list_h list, size_t index,
                                                          csr_cs_detected_h *pdetected);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/include/csr/csr-engine-manager.h b/src/include/csr/csr-engine-manager.h
index df9f0dd..4efa65c 100644 (file)
--- a/src/include/csr/csr-engine-manager.h
+++ b/src/include/csr/csr-engine-manager.h
@@ -30,6 +30,11 @@ extern "C" {
 #endif
 
 /**
+ * @addtogroup CAPI_CSR_FRAMEWORK_ADMIN_MODULE
+ * @{
+ */
+
+/**
  * @brief Engine handle
  * @since_tizen 3.0
  */
@@ -288,6 +293,10 @@ int csr_engine_get_state(csr_engine_h engine, csr_state_e *pstate);
  */
 int csr_engine_destroy(csr_engine_h engine);
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/include/csr/csr-error.h b/src/include/csr/csr-error.h
index 2e1ee5a..fc6981d 100644 (file)
--- a/src/include/csr/csr-error.h
+++ b/src/include/csr/csr-error.h
@@ -28,6 +28,12 @@
 extern "C" {
 #endif
 
+
+/**
+ * @addtogroup CAPI_CSR_FRAMEWORK_TYPES_MODULE
+ * @{
+ */
+
 /* define it temporary until this code goes into capi-base-common package */
 #ifndef TIZEN_ERROR_CSR
 #define TIZEN_ERROR_CSR 0x6000 // 0110 0000 0000 0000
@@ -76,6 +82,9 @@ typedef enum {
  */
 int csr_get_error_string(int error_code, char **string);
 
+/**
+ * @}
+ */
 
 #ifdef __cplusplus
 }

diff --git a/src/include/csr/csr-web-protection-types.h b/src/include/csr/csr-web-protection-types.h
index 422f76d..76d3178 100644 (file)
--- a/src/include/csr/csr-web-protection-types.h
+++ b/src/include/csr/csr-web-protection-types.h
@@ -27,6 +27,11 @@ extern "C" {
 #endif
 
 /**
+ * @addtogroup CAPI_CSR_FRAMEWORK_TYPES_MODULE
+ * @{
+ */
+
+/**
  * @brief CSR WP context handle.
  * @since_tizen 3.0
  */
@@ -68,6 +73,10 @@ typedef enum {
        CSR_WP_RISK_HIGH       = 0x04   /**< High Risk.Do not process the url and just notify the user */
 } csr_wp_risk_level_e;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/include/csr/csr-web-protection.h b/src/include/csr/csr-web-protection.h
index 1c8f892..f3162ae 100644 (file)
--- a/src/include/csr/csr-web-protection.h
+++ b/src/include/csr/csr-web-protection.h
@@ -29,6 +29,12 @@
 extern "C" {
 #endif
 
+
+/**
+ * @addtogroup CAPI_CSR_FRAMEWORK_WP_MODULE
+ * @{
+ */
+
 //==============================================================================
 // Main function related
 //==============================================================================
@@ -231,6 +237,10 @@ int csr_wp_result_get_detailed_url(csr_wp_check_result_h result, char **pdetaile
 int csr_wp_result_get_user_response(csr_wp_check_result_h result, csr_wp_user_response_e *presponse);
 
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif