Fix documentation issues in E2EE API

Issues raised by check-header.py
https://github.sec.samsung.net/RPO7-TIZEN/tizen-native-api-review-script

Change-Id: Id9d2423315c5a4a7384f7c7acb5bc9df6ef59776

diff --git a/src/include/device_certificate_manager.h b/src/include/device_certificate_manager.h
index 805fd2f..698ca5e 100644 (file)
--- a/src/include/device_certificate_manager.h
+++ b/src/include/device_certificate_manager.h
@@ -16,8 +16,8 @@
  *
  ******************************************************************/
 
-#ifndef __DEVICE_CERTIFICATE_MANAGER_H__
-#define __DEVICE_CERTIFICATE_MANAGER_H__
+#ifndef __TIZEN_SECURITY_DEVICE_CERTIFICATE_MANAGER_H__
+#define __TIZEN_SECURITY_DEVICE_CERTIFICATE_MANAGER_H__
 
 #include <stddef.h>
 #include <tizen.h>
@@ -84,11 +84,11 @@ typedef enum {
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  *
  * @see dcm_free_key_context()
@@ -108,11 +108,11 @@ int dcm_create_key_context(const char *service, const char *usage, const char *k
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_NO_DATA No such key context object
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  *
@@ -137,11 +137,11 @@ int dcm_free_key_context(void *key_ctx);
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_NO_DATA No certificate chain available
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  */
@@ -161,11 +161,11 @@ int dcm_get_certificate_chain(const void *key_ctx, char **cert_chain, size_t *ce
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_NO_DATA No certificate chain available
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  */
@@ -187,11 +187,11 @@ int dcm_get_key_bit_length(const void *key_ctx, size_t *key_bit_len);
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_NO_DATA No certificate chain available
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  */
@@ -218,11 +218,11 @@ int dcm_get_key_type(const void *key_ctx, char **key_type);
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
- * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
- * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
+ * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
+ * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  */
 int dcm_create_signature(const void *key_ctx, dcm_digest_algorithm_e md,
@@ -230,13 +230,12 @@ int dcm_create_signature(const void *key_ctx, dcm_digest_algorithm_e md,
                          char **signature, size_t *signature_len);
 
 /**
- * @brief Handle to a struct containing E2EE message bundle
+ * @brief Handle to a struct containing E2EE message bundle.
  * @since_tizen 6.5
  */
 typedef struct dcm_e2ee_bundle_s* dcm_e2ee_bundle_h;
 
 /**
- * @platform
  * @brief Creates an E2EE message bundle from a binary message.
  * @since_tizen 6.5
  *
@@ -250,9 +249,9 @@ typedef struct dcm_e2ee_bundle_s* dcm_e2ee_bundle_h;
  * @return #DCM_ERROR_NONE on success, otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
+ * @retval #DCM_ERROR_NOT_SUPPORTED The message is not in Tizen platform format.
  * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid (message = NULL or bundle = NULL)
  *                                      or the message format is invalid.
- * @retval #DCM_ERROR_NOT_SUPPORTED The message is not in Tizen platform format.
  *
  * @see dcm_e2ee_free_bundle()
  * @see #dcm_e2ee_bundle_h
@@ -260,7 +259,6 @@ typedef struct dcm_e2ee_bundle_s* dcm_e2ee_bundle_h;
 int dcm_e2ee_create_bundle(unsigned char *message, size_t message_len, dcm_e2ee_bundle_h* bundle);
 
 /**
- * @platform
  * @brief Releases the memory associated with E2EE message bundle.
  * @since_tizen 6.5
  *
@@ -274,7 +272,6 @@ int dcm_e2ee_create_bundle(unsigned char *message, size_t message_len, dcm_e2ee_
 void dcm_e2ee_free_bundle(dcm_e2ee_bundle_h bundle);
 
 /**
- * @platform
  * @brief Retrieves a pointer to the whole binary message contained in the E2EE bundle.
  * @since_tizen 6.5
  *
@@ -300,7 +297,6 @@ int dcm_e2ee_get_bundle_message(const dcm_e2ee_bundle_h bundle,
                                 size_t* message_len);
 
 /**
- * @platform
  * @brief Retrieves a pointer to the platform string contained in the E2EE bundle.
  * @since_tizen 6.5
  *
@@ -323,7 +319,6 @@ int dcm_e2ee_get_bundle_message(const dcm_e2ee_bundle_h bundle,
 int dcm_e2ee_get_bundle_platform(const dcm_e2ee_bundle_h bundle, const char** platform);
 
 /**
- * @platform
  * @brief Retrieves a pointer to the package id string contained in the E2EE bundle.
  * @since_tizen 6.5
  *
@@ -346,7 +341,6 @@ int dcm_e2ee_get_bundle_platform(const dcm_e2ee_bundle_h bundle, const char** pl
 int dcm_e2ee_get_bundle_pkg_id(const dcm_e2ee_bundle_h bundle, const char** pkg_id);
 
 /**
- * @platform
  * @brief Retrieves a pointer to the payload byte sequence contained in the E2EE bundle.
  * @since_tizen 6.5
  *
@@ -397,12 +391,12 @@ int dcm_e2ee_get_bundle_payload(const dcm_e2ee_bundle_h bundle,
  *         otherwise a negative error value
  *
  * @retval #DCM_ERROR_NONE Successful
+ * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
+ * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
  * @retval #DCM_ERROR_INVALID_PARAMETER Input parameter is invalid (@a key_ctx = NULL, @a payload =
  *                                      NULL but @a payload_len > 0, @a bundle = NULL, @a signature
  *                                      = NULL or @a signature_len = NULL)
  * @retval #DCM_ERROR_OUT_OF_MEMORY Out of memory during processing
- * @retval #DCM_ERROR_PERMISSION_DENIED Failed to access device certificate manager
- * @retval #DCM_ERROR_NOT_SUPPORTED Feature needed to run API is not supported
  * @retval #DCM_ERROR_SOCKET Socket error between client and server
  * @retval #DCM_ERROR_UNKNOWN Unknown error
  *
@@ -425,4 +419,4 @@ int dcm_e2ee_create_signed_bundle(const void *key_ctx,
 }
 #endif
 
-#endif /* __DEVICE_CERTIFICATE_MANAGER_H__ */
+#endif /* __TIZEN_SECURITY_DEVICE_CERTIFICATE_MANAGER_H__ */