summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHyunwoo Kim <hwlove.kim@samsung.com>2013-07-15 11:59:32 +0900
committerHyunwoo Kim <hwlove.kim@samsung.com>2013-07-15 11:59:39 +0900
commit4450b321ac54d5b3e6ffbf86c0c73923ac3eb64c (patch)
treebec1bc91c067c02a3bf81066c1541a39655449f8
parent3367c531c70bb85940eb9717c1e771fb21659699 (diff)
downloadsecure-element-4450b321ac54d5b3e6ffbf86c0c73923ac3eb64c.tar.gz
secure-element-4450b321ac54d5b3e6ffbf86c0c73923ac3eb64c.tar.bz2
secure-element-4450b321ac54d5b3e6ffbf86c0c73923ac3eb64c.zip
Apply doxygen review
Change-Id: If46f5ae09002fddd592a077fe67f070b3460554b Signed-off-by: Hyunwoo Kim <hwlove.kim@samsung.com>
-rw-r--r--inc/FSecSeISecureElementChannelCloseResponseListener.h15
-rw-r--r--inc/FSecSeISecureElementChannelTransmitResponseListener.h21
-rw-r--r--inc/FSecSeISecureElementReaderOpenSessionResponseListener.h19
-rw-r--r--inc/FSecSeISecureElementServiceEventListener.h23
-rw-r--r--inc/FSecSeISecureElementSessionCloseResponseListener.h13
-rw-r--r--inc/FSecSeISecureElementSessionGetAtrResponseListener.h20
-rw-r--r--inc/FSecSeISecureElementSessionOpenChannelResponseListener.h25
-rw-r--r--inc/FSecSeSecureElementChannel.h62
-rw-r--r--inc/FSecSeSecureElementReader.h62
-rw-r--r--inc/FSecSeSecureElementService.h52
-rw-r--r--inc/FSecSeSecureElementSession.h92
-rw-r--r--inc/FSecSecureElement.h10
12 files changed, 211 insertions, 203 deletions
diff --git a/inc/FSecSeISecureElementChannelCloseResponseListener.h b/inc/FSecSeISecureElementChannelCloseResponseListener.h
index 273f553..c6877a8 100644
--- a/inc/FSecSeISecureElementChannelCloseResponseListener.h
+++ b/inc/FSecSeISecureElementChannelCloseResponseListener.h
@@ -16,7 +16,7 @@
/**
- * @file FSecSeISecureElementChannelCloseResponseListener.h
+ * @file FSecSeISecureElementChannelCloseResponseListener.h
* @brief This is the header file for the %ISecureElementReaderListener interface.
*
* This header file contains the declarations of the %ISecureElementReaderListener interface.
@@ -32,8 +32,8 @@ namespace Tizen { namespace Security { namespace SecureElement
/**
* @interface ISecureElementChannelCloseResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementChannel::Close() operation.
- * @since 2.2
+ * @brief This interface is a listener interface that receives the result of a SecureElementChannel::Close() operation.
+ * @since 2.2
*
* The %ISecureElementChannelCloseResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementChannel::Close() operation.
*
@@ -45,19 +45,20 @@ class _OSP_EXPORT_ ISecureElementChannelCloseResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
* @since 2.2
*/
virtual ~ISecureElementChannelCloseResponseListener(void) {}
/**
- * Called when The channel is closed. @n
+ * Called when a secure element channel is closed.
*
* @since 2.2
* @param[in] reqId The request ID
- * @param[in] r The error code that occurs during Secure Element channel close operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * @param[in] r The error code that occurs during a SecureElementChannel::Close() operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementChannelCloseResponseReceived(RequestId reqId, result r) = 0;
diff --git a/inc/FSecSeISecureElementChannelTransmitResponseListener.h b/inc/FSecSeISecureElementChannelTransmitResponseListener.h
index 49c3186..4574b12 100644
--- a/inc/FSecSeISecureElementChannelTransmitResponseListener.h
+++ b/inc/FSecSeISecureElementChannelTransmitResponseListener.h
@@ -15,7 +15,7 @@
//
/**
- * @file FSecSeISecureElementChannelTransmitResponseListener.h
+ * @file FSecSeISecureElementChannelTransmitResponseListener.h
* @brief This is the header file for the %ISecureElementReaderListener interface.
*
* This header file contains the declarations of the %ISecureElementReaderListener interface.
@@ -36,8 +36,8 @@ namespace Tizen { namespace Security { namespace SecureElement
/**
* @interface ISecureElementChannelTransmitResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementChannel::Transmit() operation.
- * @since 2.2
+ * @brief This interface is a listener interface that receives the result of a SecureElementChannel::Transmit() operation.
+ * @since 2.2
*
* The %ISecureElementChannelTransmitResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementChannel::Transmit() operation.
*
@@ -49,21 +49,22 @@ class _OSP_EXPORT_ ISecureElementChannelTransmitResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
- * @since 2.2
+ * @since 2.2
*/
virtual ~ISecureElementChannelTransmitResponseListener(void) {}
/**
- * Called when APDU transmission is completed. @n
+ * Called when an APDU transmission is completed.
*
- * @since 2.2
+ * @since 2.2
* @param[in] reqId The request ID
* @param[in] pResponse The response APDU of the transmitted command APDU, @n
- * else @c null if an exception occurs @n
- * @param[in] r The error code that occurs during APDU transmission operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * else @c null if an exception occurs
+ * @param[in] r The error code that occurs during a SecureElementChannel::Transmit() operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementChannelTransmitResponseReceivedN(RequestId reqId, Tizen::Base::ByteBuffer* pResponse, result r) = 0;
diff --git a/inc/FSecSeISecureElementReaderOpenSessionResponseListener.h b/inc/FSecSeISecureElementReaderOpenSessionResponseListener.h
index 2e39901..c62241c 100644
--- a/inc/FSecSeISecureElementReaderOpenSessionResponseListener.h
+++ b/inc/FSecSeISecureElementReaderOpenSessionResponseListener.h
@@ -16,7 +16,7 @@
/**
- * @file FSecSeISecureElementReaderOpenSessionResponseListener.h
+ * @file FSecSeISecureElementReaderOpenSessionResponseListener.h
* @brief This is the header file for the %ISecureElementReaderOpenSessionResponseListener interface.
*
* This header file contains the declarations of the %ISecureElementReaderOpenSessionResponseListener interface.
@@ -32,8 +32,8 @@ namespace Tizen { namespace Security { namespace SecureElement
class SecureElementSession;
/**
* @interface ISecureElementReaderOpenSessionResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementReader::OpenSession() operation.
- * @since 2.2
+ * @brief This interface is a listener interface that receives the result of a SecureElementReader::OpenSession() operation.
+ * @since 2.2
*
* The %ISecureElementReaderOpenSessionResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementReader::OpenSession() operation.
*
@@ -45,21 +45,22 @@ class _OSP_EXPORT_ ISecureElementReaderOpenSessionResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
* @since 2.2
*/
virtual ~ISecureElementReaderOpenSessionResponseListener(void) {}
/**
- * Called when Secure Element Session is opened. @n
+ * Called when a secure element session is opened.
*
* @since 2.2
* @param[in] reqId The request ID
- * @param[in] pSecureElementSession The opened SecureElementSession instance, @n
- * else @c null if an exception occurs @n
- * @param[in] r The error code that occurs during Secure Element session open operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * @param[in] pSecureElementSession The opened %SecureElementSession instance, @n
+ * else @c null if an exception occurs
+ * @param[in] r The error code that occurs during a SecureElementReader::OpenSession() operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementReaderOpenSessionResponseReceived(RequestId reqId, SecureElementSession* pSecureElementSession, result r) = 0;
diff --git a/inc/FSecSeISecureElementServiceEventListener.h b/inc/FSecSeISecureElementServiceEventListener.h
index 6b17485..a5f1395 100644
--- a/inc/FSecSeISecureElementServiceEventListener.h
+++ b/inc/FSecSeISecureElementServiceEventListener.h
@@ -15,7 +15,7 @@
//
/**
- * @file FSecSeISecureElementServiceEventListener.h
+ * @file FSecSeISecureElementServiceEventListener.h
* @brief This is the header file for the %ISecureElementServiceEventListener interface.
*
* This header file contains the declarations of the %ISecureElementServiceEventListener interface.
@@ -31,10 +31,10 @@ class SecureElementService;
/**
* @interface ISecureElementServiceEventListener
- * @brief This interface is the listener of secure element service event.
- * @since 2.2
+ * @brief This interface is an event listener interface that listens to secure element services.
+ * @since 2.2
*
- * The %ISecureElementServiceEventListener interface must be registered and implemented by an application to receive secure element service events from the system.
+ * The %ISecureElementServiceEventListener interface must be registered and implemented by an application to listen to secure element services.
*
* @see SecureElementService
*/
@@ -44,19 +44,20 @@ class _OSP_EXPORT_ ISecureElementServiceEventListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
- * @since 2.2
+ * @since 2.2
*/
virtual ~ISecureElementServiceEventListener(void) {}
/**
- * Called when Secure Element service is connected. @n
- * @since 2.2
+ * Called when a secure element service is connected.
+ * @since 2.2
*
- * @param[in] secureElementService The connected SecureElementService instance.
- * @param[in] r The error code that occurs during Secure Element Service connection operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * @param[in] secureElementService The connected SecureElementService instance
+ * @param[in] r The error code that occurs during a secure element service connection operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementServiceConnected(SecureElementService& secureElementService, result r) = 0;
diff --git a/inc/FSecSeISecureElementSessionCloseResponseListener.h b/inc/FSecSeISecureElementSessionCloseResponseListener.h
index 097afb4..4f684bd 100644
--- a/inc/FSecSeISecureElementSessionCloseResponseListener.h
+++ b/inc/FSecSeISecureElementSessionCloseResponseListener.h
@@ -16,7 +16,7 @@
/**
- * @file FSecSeISecureElementSessionCloseResponseListener.h
+ * @file FSecSeISecureElementSessionCloseResponseListener.h
* @brief This is the header file for the %ISecureElementSessionCloseResponseListener interface.
* @since 2.2
*
@@ -33,7 +33,7 @@ namespace Tizen { namespace Security { namespace SecureElement
/**
* @interface ISecureElementSessionCloseResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementSession::Close() operation.
+ * @brief This interface is a listener interface that receives the result of a SecureElementSession::Close() operation.
* @since 2.2
*
* The %ISecureElementSessionCloseResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementSession::Close() operation.
@@ -46,19 +46,20 @@ class _OSP_EXPORT_ ISecureElementSessionCloseResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
* @since 2.2
*/
virtual ~ISecureElementSessionCloseResponseListener(void) {}
/**
- * Called when Secure Element Session is closed. @n
+ * Called when a secure element session is closed.
* @since 2.2
*
* @param[in] reqId The request ID
- * @param[in] r The error code that occurs during Secure Element session close operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * @param[in] r The error code that occurs during a SecureElementSession::Close() operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementSessionCloseResponseReceived(RequestId reqId, result r) = 0;
diff --git a/inc/FSecSeISecureElementSessionGetAtrResponseListener.h b/inc/FSecSeISecureElementSessionGetAtrResponseListener.h
index 8740436..5873d3d 100644
--- a/inc/FSecSeISecureElementSessionGetAtrResponseListener.h
+++ b/inc/FSecSeISecureElementSessionGetAtrResponseListener.h
@@ -16,7 +16,7 @@
/**
- * @file FSecSeISecureElementSessionGetAtrResponseListener.h
+ * @file FSecSeISecureElementSessionGetAtrResponseListener.h
* @brief This is the header file for the %ISecureElementSessionGetAtrResponseListener interface.
*
* This header file contains the declarations of the %ISecureElementSessionGetAtrResponseListener interface.
@@ -37,8 +37,8 @@ namespace Tizen { namespace Security { namespace SecureElement
/**
* @interface ISecureElementSessionGetAtrResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementSession::GetAtr() operation.
- * @since 2.2
+ * @brief This interface is a listener interface designed that receives the result of a SecureElementSession::GetAtr() operation.
+ * @since 2.2
*
* The %ISecureElementSessionGetAtrResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementSession::GetAtr() operation.
*
@@ -50,21 +50,23 @@ class _OSP_EXPORT_ ISecureElementSessionGetAtrResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
* @since 2.2
*/
virtual ~ISecureElementSessionGetAtrResponseListener(void) {}
/**
- * Called when ATR response is received.
- * The received ATR can be null.
+ * Called when an ATR response is received. @n
+ * The received ATR response can be @c null.
*
* @since 2.2
* @param[in] reqId The request ID
- * @param[in] pAtr The ATR of Secure Element. Null pointer can be possible if secure element has not ATR.
- * @param[in] r The error code that occurs during ATR retrieving operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
+ * @param[in] pAtr A pointer to the ATR of a secure element @n
+ The pointer can be @c null if the secure element has no ATR.
+ * @param[in] r The error code that occurs during an ATR retrieving operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementSessionGetAtrResponseReceivedN(RequestId reqId, Tizen::Base::ByteBuffer* pAtr, result r) = 0;
diff --git a/inc/FSecSeISecureElementSessionOpenChannelResponseListener.h b/inc/FSecSeISecureElementSessionOpenChannelResponseListener.h
index b5b8320..6d4f765 100644
--- a/inc/FSecSeISecureElementSessionOpenChannelResponseListener.h
+++ b/inc/FSecSeISecureElementSessionOpenChannelResponseListener.h
@@ -15,9 +15,9 @@
//
/**
- * @file FSecSeISecureElementSessionOpenChannelResponseListener.h
+ * @file FSecSeISecureElementSessionOpenChannelResponseListener.h
* @brief This is the header file for the %ISecureElementSessionOpenChannelResponseListener interface.
- * @since 2.2
+ * @since 2.2
*
* This header file contains the declarations of the %ISecureElementSessionOpenChannelResponseListener interface.
*/
@@ -33,8 +33,8 @@ class SecureElementChannel;
/**
* @interface ISecureElementSessionOpenChannelResponseListener
- * @brief This interface is the listener to receive the result of the SecureElementSession::OpenChannel() operation.
- * @since 2.2
+ * @brief This interface is a listener interface that receives the result of a SecureElementSession::OpenChannel() operation.
+ * @since 2.2
*
* The %ISecureElementSessionOpenChannelResponseListener interface must be registered and implemented by an application to receive the result of the SecureElementSession::OpenChannel() operation.
*
@@ -46,22 +46,23 @@ class _OSP_EXPORT_ ISecureElementSessionOpenChannelResponseListener
public:
/**
- * This polymorphic destructor should be overridden if required. @n
+ * This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
- * @since 2.2
+ * @since 2.2
*/
virtual ~ISecureElementSessionOpenChannelResponseListener(void) {}
/**
- * Called when Secure Element Channel is opened. @n
+ * Called when a secure element channel is opened.
*
* @since 2.2
* @param[in] reqId The request ID
- * @param[in] pSecureElementChannel The opened SecureElementSession instance, @n
- * else @c null if an exception occurs @n
- * @param[in] r The error code that occurs during Secure Element channel open operation, the following exception may be given through this parameter.
- * @exception E_SUCCESS The method was successful.
- * @exception E_ILLEGAL_ACCESS The application cannot be granted to access the applet.
+ * @param[in] pSecureElementChannel The opened SecureElementChannel instance, @n
+ * else @c null if an exception occurs
+ * @param[in] r The error code that occurs during a SecureElementSession::OpenBasicChannel() operation or SecureElementSession::OpenLogicalChannel() operation @n
+ * The following exception can be given through this parameter.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_ILLEGAL_ACCESS The application cannot be granted access to the applet.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
virtual void OnSecureElementSessionOpenChannelResponseReceived(RequestId reqId, SecureElementChannel* pSecureElementChannel, result r) = 0;
diff --git a/inc/FSecSeSecureElementChannel.h b/inc/FSecSeSecureElementChannel.h
index cc0d5c5..7b0f141 100644
--- a/inc/FSecSeSecureElementChannel.h
+++ b/inc/FSecSeSecureElementChannel.h
@@ -15,10 +15,10 @@
//
/**
- * @file FSecSeSecureElementChannel.h
+ * @file FSecSeSecureElementChannel.h
* @brief This is the header file for the %SecureElementChannel class.
*
- * This header file contains the declarations of the %SecureElementChannel interface.
+ * This header file contains the declarations of the %SecureElementChannel class.
*/
#ifndef _FSEC_SE_SECURE_ELEMENT_CHANNEL_H_
#define _FSEC_SE_SECURE_ELEMENT_CHANNEL_H_
@@ -39,12 +39,12 @@ class ISecureElementChannelTransmitResponseListener;
/**
* @class SecureElementChannel
- * @brief This class is used to send APDUs to the secure elements.
- * @since 2.2
+ * @brief This class is used to send APDUs to secure elements.
+ * @since 2.2
*
* @final This class is not intended for extension.
*
- * The %SecureElementChannel is used to send APDUs to the secure elements.
+ * The %SecureElementChannel class is used to send APDUs to secure elements.
*/
class _OSP_EXPORT_ SecureElementChannel
: public Tizen::Base::Object
@@ -59,34 +59,34 @@ public:
virtual ~SecureElementChannel(void);
/**
- * Gets SecureElementSession instance Which this SecureElementChannel bound to
+ * Gets a SecureElementSession instance, to which this %SecureElementChannel instance is bound.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return A pointer to the SecureElementReader instance which this SecureElementSession instance is bound to
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The return value is owned by Platform. Do not release it.
+ * @return A pointer to a SecureElementSession instance, to which this %SecureElementChannel instance is bound
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The return value is owned by platform and do not delete it.
*
*/
SecureElementSession* GetSecureElementSession(void) const;
/**
- * Closes this channel to the secure element. @n
- * If the channel already closed, this method will be ignored.
+ * Closes the channel to a secure element. @n
+ * If the channel is already closed, this method is ignored.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @param[in] pListener The result listener
- * @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @param[in] pListener The result listener
+ * @param[out] reqId The unique request ID assigned to the asynchronous operation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result Close(ISecureElementChannelCloseResponseListener* pListener, RequestId& reqId);
@@ -98,10 +98,10 @@ public:
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return @c true if the session is basic channel, @n
+ * @return @c true if the channel is a basic channel, @n
* else @c false
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
*/
@@ -116,31 +116,31 @@ public:
*
* @return @c true if the channel is closed, @n
* else @c false
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
*/
bool IsClosed(void) const;
/**
- * Transmits an APDU command to the secure element.
+ * Transmits an APDU command to a secure element.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @param[in] pCommand The APDU command ByteBuffer instance.
+ * @param[in] pCommand The APDU command ByteBuffer instance
* @param[in] pListener The result listener
* @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_INVALID_ARG The APDU command has invalid format.
- * @exception E_IO There is communication problem to the reader or the Secure element.
- * @exception E_INVALID_STATE The Secure Element channel is used after being closed.
- * @exception E_UNAUTHORIZED_ACCESS The APDU command is filtered by the security policy
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified APDU command has an invalid format.
+ * @exception E_IO A communication error has occurred while communicating with the reader and the secure element.
+ * @exception E_INVALID_STATE The secure element channel has been used after it was closed.
+ * @exception E_UNAUTHORIZED_ACCESS The APDU command is filtered by the security policy.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result Transmit(const Tizen::Base::ByteBuffer* pCommand, ISecureElementChannelTransmitResponseListener* pListener, RequestId& reqId);
diff --git a/inc/FSecSeSecureElementReader.h b/inc/FSecSeSecureElementReader.h
index a0ad40f..943dba0 100644
--- a/inc/FSecSeSecureElementReader.h
+++ b/inc/FSecSeSecureElementReader.h
@@ -16,10 +16,10 @@
/**
- * @file FSecSeSecureElementReader.h
+ * @file FSecSeSecureElementReader.h
* @brief This is the header file for the %SecureElementReader class.
*
- * This header file contains the declarations of the %SecureElementReader interface.
+ * This header file contains the declarations of the %SecureElementReader class.
*/
#ifndef _FSEC_SE_SECURE_ELEMENT_READER_H_
#define _FSEC_SE_SECURE_ELEMENT_READER_H_
@@ -35,14 +35,14 @@ class ISecureElementReaderOpenSessionResponseListener;
/**
* @class SecureElementReader
- * @brief This class is used to check the secure element status and open sessions to the secure elements.
+ * @brief This class is used to check the secure element status and to open sessions to the secure elements.
* @since 2.2
*
* @final This class is not intended for extension.
*
- * The %SecureElementReader is used to check the secure element status and open sessions to the secure elements.
+ * The %SecureElementReader class is used to check the secure element status and to open sessions to the secure elements.
*
- * The following example demonstrates how to use the %SecureElementService class to connect to the secure element infrastructure and get access to a list of secure element readers.
+ * The following example demonstrates how to use the %SecureElementReader class to connect to a secure element's infrastructure and get access to a list of secure element readers.
*
* @code
#include <FBase.h>
@@ -82,34 +82,34 @@ public:
virtual ~SecureElementReader(void);
/**
- * Gets the user friendly name of the reader. @n
- * If the reader is a SIM reader, then the name is start with the "SIM" prefix.@
- * If the reader is a SD reader or micro SD reader, then the name is start with the "SD" prefix.@
- * If the reader is a embedded SE reader, then the name is start with the "eSE" prefix.@
+ * Gets the user friendly name of the reader.
+ * If the reader is a SIM reader, then the name starts with the prefix @c SIM.
+ * If the reader is an SD reader or a micro SD reader, then the name starts with the prefix @c SD.
+ * If the reader is an embedded SE reader, then the name starts with the prefix @c eSE.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return The name of the reader.
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks Currently, It supports only SIM reader.
+ * @return The name of the reader
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks Currently, this method supports only SIM readers.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetName(void) const;
/**
- * Gets SecureElementService instance Which this SecureElementReader bound to
+ * Gets a SecureElementService instance, to which this %SecureElementReader is bound.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return A pointer to the SecureElementService instance which this SecureElementReader instance is bound to
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The return value is owned by Platform. Do not release it.
+ * @return A pointer to a %SecureElementService instance, to which this %SecureElementReader instance is bound
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The return value is owned by platform and do not delete it.
*
*/
SecureElementService* GetSecureElementService(void) const;
@@ -121,16 +121,16 @@ public:
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return @c true if the service is connected, @n
+ * @return @c true if the secure element is present, @n
* else @c false
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsSecureElementPresent(void) const;
/**
- * Connects to a secure element in this reader.
+ * Connects to a secure element in the reader.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
@@ -138,24 +138,24 @@ public:
* @return An error code
* @param[in] pListener The result listener
* @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_IO An I/O error has occurred when communication with the secure element or the reader.
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_IO An I/O error has occurred while communicating with the secure element or the reader.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*/
result OpenSession(ISecureElementReaderOpenSessionResponseListener* pListener, RequestId& reqId);
/**
- * Closes all sessions which was opened on this reader. @n
- * All the channels opened by all these sessions will be closed, too.
+ * Closes all sessions that are open on this reader. @n
+ * Also closes all the channels that are opened by these sessions.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return An error code.
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result CloseAllSessions(void);
diff --git a/inc/FSecSeSecureElementService.h b/inc/FSecSeSecureElementService.h
index 3554a62..f78434e 100644
--- a/inc/FSecSeSecureElementService.h
+++ b/inc/FSecSeSecureElementService.h
@@ -16,10 +16,10 @@
/**
- * @file FSecSeSecureElementService.h
+ * @file FSecSeSecureElementService.h
* @brief This is the header file for the %SecureElementService class.
*
- * This header file contains the declarations of the %SecureElementService interface.
+ * This header file contains the declarations of the %SecureElementService class.
*/
#ifndef _FSEC_SE_SECURE_ELEMENT_SERVICE_H_
#define _FSEC_SE_SECURE_ELEMENT_SERVICE_H_
@@ -43,9 +43,9 @@ class ISecureElementServiceEventListener;
*
* @final This class is not intended for extension.
*
- * The %SecureElementService is used to connect to the secure element infrastructure and get access to a list of secure element readers.
+ * The %SecureElementService class is used to connect to a secure element's infrastructure and get access to a list of secure element readers.
*
- * The following example demonstrates how to use the %SecureElementService class to connect to the secure element infrastructure and get access to a list of secure element readers.
+ * The following example demonstrates how to use the %SecureElementService class to connect to a secure element's infrastructure and get access to a list of secure element readers.
*
* @code
#include <FBase.h>
@@ -89,8 +89,8 @@ public:
virtual ~SecureElementService(void);
/**
- * Establishes a new connection that can be used to connect to all the Secure Elements available in the device. @n
- * If connection is established, ISecureElementServiceEventListener::OnSecureElementServiceConnected() will be called.
+ * Establishes a new connection that can be used to connect to all the secure elements available in the device.
+ * If a connection is established, ISecureElementServiceEventListener::OnSecureElementServiceConnected() is called.
*
* @since 2.2
* @privlevel public
@@ -98,30 +98,30 @@ public:
* @feature %http://tizen.org/feature/network.secure_element
*
* @return An error code
- * @param[in] pListener The listener to receive secure element events.
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_UNSUPPORTED_OPERATION The method has failed because the device does not support the Secure Element feature.
- * @exception E_INVALID_ARG The specified @c pListener is null.
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @param[in] pListener A listener that receives the secure element events
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_UNSUPPORTED_OPERATION The method has failed because the device does not support this secure element feature.
+ * @exception E_INVALID_ARG The specified @c pListener is @c null.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*/
result Initialize(ISecureElementServiceEventListener* pListener);
/**
- * Gets the list of available secure element readers.
+ * Gets a list of available secure element readers.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return A pointer to a list containing SecureElementReader instance@n
- * An empty list is returned if there is no result and there is no error, @n
- * else @c null if an exception occurs or this instance is not connected to secure element.
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @return A pointer to a list containing a %SecureElementReader instance, @n
+ * An empty list is returned if there is no result and no error, @n
+ * else @c null if an exception occurs or this instance is not connected to a secure element.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The specific error code can be accessed using the GetLastResult() method.@n
- * The return value is owned by Platform and must not be deleted by the caller. @n
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The return value is owned by platform and do not delete it.
*/
const Tizen::Base::Collection::IList* GetSecureElementReaderList(void) const;
@@ -134,22 +134,22 @@ public:
*
* @return @c true if the service is connected, @n
* else @c false
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsConnected(void) const;
/**
- * Release all secure element resources allocated by this instance including any binding to an underlying service. @n
- * As a result IsConnected() will return false after this method was called.
+ * Releases all the secure element resources allocated by this instance including those that are binding to an underlying service. @n
+ * As a result, the IsConnected() method returns @c false after this method is called.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Shutdown(void);
diff --git a/inc/FSecSeSecureElementSession.h b/inc/FSecSeSecureElementSession.h
index 3ab5ed9..db51dff 100644
--- a/inc/FSecSeSecureElementSession.h
+++ b/inc/FSecSeSecureElementSession.h
@@ -16,10 +16,10 @@
/**
- * @file FSecSeSecureElementSession.h
+ * @file FSecSeSecureElementSession.h
* @brief This is the header file for the %SecureElementSession class.
*
- * This header file contains the declarations of the %SecureElementSession interface.
+ * This header file contains the declarations of the %SecureElementSession class.
*/
#ifndef _FSEC_SE_SECURE_ELEMENT_SESSION_H_
#define _FSEC_SE_SECURE_ELEMENT_SESSION_H_
@@ -41,14 +41,14 @@ class ISecureElementSessionOpenChannelResponseListener;
/**
* @class SecureElementSession
- * @brief This class is used to open channels to the secure elements.
+ * @brief This class is used to open channels to secure elements.
* @since 2.2
*
* @final This class is not intended for extension.
*
- * The %SecureElementSession is used to open channels to the secure elements
+ * The %SecureElementSession class is used to open channels to secure elements.
*
- * The following example demonstrates how to use the %SecureElementSession class to open channels to the secure elements.
+ * The following example demonstrates how to use the %SecureElementSession class to open channels to secure elements.
*
* @code
#include <FBase.h>
@@ -85,22 +85,22 @@ public:
virtual ~SecureElementSession(void);
/**
- * Gets SecureElementReader instance Which this SecureElementSession bound to
+ * Gets a SecureElementReader instance, to which this %SecureElementSession instance is bound.
* @since 2.2
*
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
- * @return A pointer to the SecureElementReader instance which this SecureElementSession instance is bound to
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The return value is owned by Platform. Do not release it.
+ * @return A pointer to a %SecureElementReader instance, to which this %SecureElementSession instance is bound
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The return value is owned by platform and do not release it.
*
*/
SecureElementReader* GetSecureElementReader(void) const;
/**
- * Gets the ATR (Answer To Reset) of the secure element.
+ * Gets the ATR (Answer To Reset) of a secure element.
*
* @since 2.2
* @privlevel public
@@ -109,16 +109,16 @@ public:
* @return An error code
* @param[in] pListener The result listener
* @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result GetAtr(ISecureElementSessionGetAtrResponseListener* pListener, RequestId& reqId) const;
/**
- * Closes the connection with the secure element. @n
- * This will close any channels opened by this application with this secure element.
+ * Closes the connection with a secure element. @n
+ * This method closes all the channels opened by the application with the secure element.
*
* @since 2.2
* @privlevel public
@@ -127,9 +127,9 @@ public:
* @return An error code
* @param[in] pListener The result listener
* @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result Close(ISecureElementSessionCloseResponseListener* pListener, RequestId& reqId);
@@ -143,67 +143,67 @@ public:
*
* @return @c true if the session is closed, @n
* else @c false
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
*/
bool IsClosed(void) const;
/**
- * Closes any channel opened on this session.
+ * Closes any channel opened during this session.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*
*/
result CloseAllChannels(void);
/**
- * Gets an access to the basic channel asynchronously.
+ * Gets access to a basic channel asynchronously.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @param[in] pAid An AID of the applet to be opened.
- * @param[in] pListener The result listener
- * @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_INVALID_ARG The length of aid is invalid.
- * @exception E_IO An I/O error has occurred when communication with the secure element.
- * @exception E_INVALID_STATE The Secure Element session is used after being closed.
- * @exception E_UNAUTHORIZED_ACCESS The calling application cannot be granted access to this AID or default Applet on this session
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @param[in] pAid An AID of the applet to open
+ * @param[in] pListener The result listener
+ * @param[out] reqId The unique request ID assigned to the asynchronous operation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified length of the aid is invalid.
+ * @exception E_IO An I/O error has occurred while communicating with the secure element.
+ * @exception E_INVALID_STATE The secure element session is used after being closed.
+ * @exception E_UNAUTHORIZED_ACCESS The calling application cannot be granted access to the AID or the default applet on this session
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result OpenBasicChannel(const Tizen::Base::ByteBuffer* pAid, ISecureElementSessionOpenChannelResponseListener* pListener, RequestId& reqId);
/**
- * Gets an access to the logical channel asynchronously.
+ * Gets access to a logical channel asynchronously.
*
* @since 2.2
* @privlevel public
* @privilege %http://tizen.org/privilege/secureelement
*
* @return An error code
- * @param[in] pAid An AID of the applet to be opened.
- * @param[in] pListener The result listener
- * @param[out] reqId The unique request ID assigned to the asynchronous operation
- * @exception E_SUCCESS The method was successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_INVALID_ARG The length of aid is invalid.
- * @exception E_IO An I/O error has occurred when communication with the secure element.
- * @exception E_INVALID_STATE The Secure Element session is used after being closed.
- * @exception E_UNAUTHORIZED_ACCESS The calling application cannot be granted access to this AID or default Applet on this session
- * @remarks The platform does not take the ownership of @c pListener after this call.
+ * @param[in] pAid An AID of the applet to open
+ * @param[in] pListener The result listener
+ * @param[out] reqId The unique request ID assigned to the asynchronous operation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_ARG The specified length of the aid is invalid.
+ * @exception E_IO An I/O error has occurred while communicating with the secure element.
+ * @exception E_INVALID_STATE The secure element session is used after being closed.
+ * @exception E_UNAUTHORIZED_ACCESS The calling application cannot be granted access to the AID or the default applet on this session.
+ * @remarks The platform does not take the ownership of the @c pListener after this call.
*
*/
result OpenLogicalChannel(const Tizen::Base::ByteBuffer* pAid, ISecureElementSessionOpenChannelResponseListener* pListener, RequestId& reqId);
diff --git a/inc/FSecSecureElement.h b/inc/FSecSecureElement.h
index 7d071bf..f7f6666 100644
--- a/inc/FSecSecureElement.h
+++ b/inc/FSecSecureElement.h
@@ -15,11 +15,11 @@
//
/**
- * @file FSecSecureElement.h
+ * @file FSecSecureElement.h
* @brief This is the header file for the %SecureElement namespace.
* @since 2.2
*
- * This is the header file for the %SecureElement namespace.
+ * This header file contains the declarations and descriptions of the %SecureElement namespace.
*/
#ifndef _FSEC_SECURE_ELEMENT_H_
#define _FSEC_SECURE_ELEMENT_H_
@@ -38,15 +38,15 @@
/**
* @namespace Tizen::Security::SecureElement
- * @brief This namespace contains classes and interfaces for managing the secure elements.
+ * @brief This namespace contains classes and interfaces for managing secure elements.
* @since 2.2
*
* @remarks @b Header @b %file: @b \#include @b <FSecSecureElement.h> @n
* @b Library : @b osp-secure-element
*
- * The %SecureElement namespace contains classes and interfaces for managing secure elements, by getting information from secure elements and sending APDUs. @n
+ * The %SecureElement namespace contains classes and interfaces for managing secure elements, by obtaining information from secure elements and sending APDUs.
*
- * For more information on the %SecureElement namespace features, see Secure Element Guide.
+ * For more information on the %SecureElement namespace features, see SecureElementGuide.
*
* The following diagram illustrates the relationships between the classes belonging to the %SecureElement namespace.
* @image html security_secure_element_classdiagram.png