From e740ad20abaa3874f1f487e0e1f33e233b60f267 Mon Sep 17 00:00:00 2001
From: Filip Skrzeczkowski <f.skrzeczkow@samsung.com>
Date: Tue, 18 Jun 2024 12:59:40 +0200
Subject: Add EXTENDED_MODULE defgroup in docs

Change-Id: I6e92dbeff5bc910f0bc9427babb7076e2a572d02
---
 doc/key-manager-extended_doc.h   | 34 +++++++++++++++++++++
 src/include/ckmc/ckmc-extended.h | 64 ++++++++++++++++++++--------------------
 2 files changed, 66 insertions(+), 32 deletions(-)
 create mode 100644 doc/key-manager-extended_doc.h

diff --git a/doc/key-manager-extended_doc.h b/doc/key-manager-extended_doc.h
new file mode 100644
index 00000000..df9a5435
--- /dev/null
+++ b/doc/key-manager-extended_doc.h
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2024 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_KEY_MANAGER_EXTENDED_DOC_H__
+#define __TIZEN_CORE_KEY_MANAGER_EXTENDED_DOC_H__
+
+
+/**
+ * @ingroup CAPI_KEY_MANAGER_MODULE
+ * @defgroup CAPI_KEY_MANAGER_EXTENDED_MODULE Key Manager Extended
+ * @brief It provides APIs that allow access to extended key manager functionality
+ * @section CAPI_KEY_MANAGER_EXTENDED_MODULE_HEADER Required Header
+ * \#include <ckmc/ckmc-extended.h>
+ *
+ * @section CAPI_KEY_MANAGER_EXTENDED_MODULE_OVERVIEW Overview
+ * It provides APIs for extended functionalty including concatenated data wrapping and unwrapping
+ */
+
+
+#endif /* __TIZEN_CORE_KEY_MANAGER_EXTENDED_DOC_H__ */
diff --git a/src/include/ckmc/ckmc-extended.h b/src/include/ckmc/ckmc-extended.h
index a96d2ea0..005f3f27 100644
--- a/src/include/ckmc/ckmc-extended.h
+++ b/src/include/ckmc/ckmc-extended.h
@@ -57,21 +57,6 @@ extern "C" {
  *          @c 1024 bits.
  * @remarks The @a ppwrapped_key should be released using ckmc_key_free().
  *
- * @code
- * ckmc_param_list_h params;    // Initialized elsewhere
- * ckmc_raw_buffer_s *data;     // Initialized elsewhere
- * ckmc_key_s *ppwrapped_key;
- * int ret = ckmc_wrap_concatenated_data(params,
- *                                       "wrapping_key_alias",
- *                                       "wrapping_key_password",
- *                                       "alias",
- *                                       "password",
- *                                       data,
- *                                       &ppwrapped_key);
- *  ...
- * ckmc_key_free(ppwrapped_key);
- * @endcode
- *
  * @param[in] params Algorithm parameter list handle. See #ckmc_param_list_h and #ckmc_algo_type_e
  *                   for details. Supported algorithms:
  *                   - #CKMC_ALGO_RSA_OAEP
@@ -100,6 +85,21 @@ extern "C" {
  *
  * @pre User is already logged in and the user key is already loaded into memory in plain text form.
  *
+ * @code
+ * ckmc_param_list_h params;    // Initialized elsewhere
+ * ckmc_raw_buffer_s *data;     // Initialized elsewhere
+ * ckmc_key_s *ppwrapped_key;
+ * int ret = ckmc_wrap_concatenated_data(params,
+ *                                       "wrapping_key_alias",
+ *                                       "wrapping_key_password",
+ *                                       "alias",
+ *                                       "password",
+ *                                       data,
+ *                                       &ppwrapped_key);
+ *  ...
+ * ckmc_key_free(ppwrapped_key);
+ * @endcode
+ *
  * @see ckmc_unwrap_concatenated_data()
  * @see #ckmc_param_list_h
  * @see #ckmc_raw_buffer_s
@@ -133,23 +133,6 @@ int ckmc_wrap_concatenated_data(const ckmc_param_list_h params,
  *          wrapped form.
  * @remarks The @a ppdata should be released using ckmc_buffer_free().
  *
- * @code
- * ckmc_param_list_h params;    // Initialized elsewhere
- * ckmc_key_s *wrapped_key;     // Initialized elsewhere
- * ckmc_policy_s policy;        // Initialized elsewhere
- * ckmc_raw_buffer_s *ppdata;
- * int ret = ckmc_unwrap_concatenated_data(params,
- *                                         "wrapping_key_alias",
- *                                         "wrapping_key_password",
- *                                         wrapped_key,
- *                                         "alias,"
- *                                         192,
- *                                         policy,
- *                                         &ppdata);
- *  ...
- * ckmc_buffer_free(ppdata);
- * @endcode
- *
  * @param[in] params Algorithm parameter list handle. See #ckmc_param_list_h and #ckmc_algo_type_e
  *                   for details. Supported algorithms:
  *                   - #CKMC_ALGO_RSA_OAEP
@@ -180,6 +163,23 @@ int ckmc_wrap_concatenated_data(const ckmc_param_list_h params,
  *
  * @pre User is already logged in and the user key is already loaded into memory in plain text form.
  *
+ * @code
+ * ckmc_param_list_h params;    // Initialized elsewhere
+ * ckmc_key_s *wrapped_key;     // Initialized elsewhere
+ * ckmc_policy_s policy;        // Initialized elsewhere
+ * ckmc_raw_buffer_s *ppdata;
+ * int ret = ckmc_unwrap_concatenated_data(params,
+ *                                         "wrapping_key_alias",
+ *                                         "wrapping_key_password",
+ *                                         wrapped_key,
+ *                                         "alias,"
+ *                                         192,
+ *                                         policy,
+ *                                         &ppdata);
+ *  ...
+ * ckmc_buffer_free(ppdata);
+ * @endcode
+ *
  * @see ckmc_wrap_concatenated_data()
  * @see #ckmc_param_list_h
  * @see #ckmc_key_s
-- 
cgit v1.2.3