Fixed Tizen doxygen rules. 71/207871/1 accepted/tizen/unified/20190613.220310 submit/tizen/20190613.103213
authorsaerome.kim <saerome.kim@samsung.com>
Thu, 13 Jun 2019 10:29:49 +0000 (19:29 +0900)
committersaerome.kim <saerome.kim@samsung.com>
Thu, 13 Jun 2019 10:31:09 +0000 (19:31 +0900)
Change-Id: I913dd017a9577ecdb3a4fd71a4c6896ac7ac07b6
Signed-off-by: saerome.kim <saerome.kim@samsung.com>
include/ClientChannel.h [changed mode: 0755->0644]
include/ClientGDBus.h [changed mode: 0755->0644]
include/Reader.h [changed mode: 0755->0644]
include/SEService.h [changed mode: 0755->0644]
include/SEServiceListener.h [changed mode: 0755->0644]
include/Session.h [changed mode: 0755->0644]
include/smartcard-service.h
include/smartcard.h [changed mode: 0755->0644]
include/smartcard_debug.h [changed mode: 0755->0644]

old mode 100755 (executable)
new mode 100644 (file)
index 8566aa9..e02d3f2
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef CLIENTCHANNEL_H_
-#define CLIENTCHANNEL_H_
+#ifndef __TIZEN_CAPI_NETWORK_CLIENT_CHANNEL_H__
+#define __TIZEN_CAPI_NETWORK_CLIENT_CHANNEL_H__
 
 /* standard library header */
 #include <gio/gio.h>
@@ -100,7 +100,7 @@ void channel_destroy_instance(channel_h handle) __attribute__((deprecated));
 }
 #endif /* __cplusplus */
 
-#endif /* CLIENTCHANNEL_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_CLIENT_CHANNEL_H__ */
 
 /* LCOV_EXCL_STOP */
 
old mode 100755 (executable)
new mode 100644 (file)
index f55271b..87a61ec
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef CLIENTGDBUS_H_
-#define CLIENTGDBUS_H_
+#ifndef __TIZEN_CAPI_NETWORK_CLIENT_GDBUS_H__
+#define __TIZEN_CAPI_NETWORK_CLIENT_GDBUS_H__
 
 /* standard library header */
 #include <glib.h>
@@ -35,7 +35,7 @@ namespace smartcard_service_api
        };
 } /* namespace smartcard_service_api */
 
-#endif /* CLIENTGDBUS_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_CLIENT_GDBUS_H__ */
 
 /* LCOV_EXCL_STOP */
 
old mode 100755 (executable)
new mode 100644 (file)
index 98763ba..ea3e30b
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef READER_H_
-#define READER_H_
+#ifndef __TIZEN_CAPI_NETWORK_READER_H__
+#define __TIZEN_CAPI_NETWORK_READER_H__
 
 /* standard library header */
 #include <glib.h>
@@ -86,7 +86,7 @@ __attribute__((deprecated)) void reader_destroy_instance(reader_h handle);
 }
 #endif /* __cplusplus */
 
-#endif /* READER_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_READER_H__ */
 
 /* LCOV_EXCL_STOP */
 
old mode 100755 (executable)
new mode 100644 (file)
index 563961e..b8bbb35
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef SESERVICE_H_
-#define SESERVICE_H_
+#ifndef __TIZEN_CAPI_NETWORK_SE_SERVICE_H__
+#define __TIZEN_CAPI_NETWORK_SE_SERVICE_H__
 
 /* standard library header */
 #include <glib.h>
@@ -129,7 +129,7 @@ int se_service_destroy_instance(se_service_h handle);
 }
 #endif /* __cplusplus */
 
-#endif /* SESERVICE_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_SE_SERVICE_H__ */
 
 /* LCOV_EXCL_STOP */
 
old mode 100755 (executable)
new mode 100644 (file)
index 69df306..3cacde0
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef SESERVICELISTENER_H_
-#define SESERVICELISTENER_H_
+#ifndef __TIZEN_CAPI_NETWORK_SESERVICE_LISTENER_H__
+#define __TIZEN_CAPI_NETWORK_SESERVICE_LISTENER_H__
 
 /* standard library header */
 
@@ -41,7 +41,7 @@ public:
        };
 } /* namespace open_mobile_api */
 
-#endif /* SESERVICELISTENER_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_SESERVICE_LISTENER_H__ */
 
 /* LCOV_EXCL_STOP */
 
old mode 100755 (executable)
new mode 100644 (file)
index b7933b5..54e2b5a
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef SESSION_H_
-#define SESSION_H_
+#ifndef __TIZEN_CAPI_NETWORK_SESSION_H__
+#define __TIZEN_CAPI_NETWORK_SESSION_H__
 
 /* standard library header */
 #include <gio/gio.h>
@@ -156,7 +156,7 @@ __attribute__((deprecated)) void session_destroy_instance(session_h handle);
 }
 #endif /* __cplusplus */
 
-#endif /* SESSION_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_SESSION_H__ */
 
 /* LCOV_EXCL_STOP */
 
index 354e11fa8f950871c8fcd1826835470e25d78dac..4f15d0c96c6926a6521c1389cccc73961d79a829 100644 (file)
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef SMARTCARD_SERVICE_H_
-#define SMARTCARD_SERVICE_H_
+#ifndef __TIZEN_CAPI_NETWORK_SMARTCARD_SERVICE_H__
+#define __TIZEN_CAPI_NETWORK_SMARTCARD_SERVICE_H__
 
 #include "smartcard-types.h"
 #ifdef __cplusplus
@@ -26,4 +26,4 @@
 #include "Session.h"
 #include "ClientChannel.h"
 
-#endif /* SMARTCARD_SERVICE_H_ */
+#endif /* __TIZEN_CAPI_NETWORK_SMARTCARD_SERVICE_H__ */
old mode 100755 (executable)
new mode 100644 (file)
index dc8e78d..687202a
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __smartcard_h__
-#define __smartcard_h__
+#ifndef __TIZEN_CAPI_NETWORK_SMARTCARD_H__
+#define __TIZEN_CAPI_NETWORK_SMARTCARD_H__
 
 #include <tizen.h>
 
@@ -29,10 +29,12 @@ extern "C" {
  * @since_tizen 2.3.1
  */
 #ifndef SMARTCARD_API
-#define SMARTCARD_API
+#define SMARTCARD_API /**< Smartcard API */
 #endif
 
-#define SMARTCARD_ERROR_CLASS TIZEN_ERROR_SMARTCARD
+#ifndef SMARTCARD_ERROR_CLASS
+#define SMARTCARD_ERROR_CLASS TIZEN_ERROR_SMARTCARD /**< Smartcard error class */
+#endif
 
 /**
  * @brief Error codes reported by the smartcard API.
@@ -56,7 +58,7 @@ typedef enum {
 } smartcard_error_e;
 
 /**
- * @brief Enumerations for Smartcard reader event type
+ * @brief Enumerations for Smartcard reader event type.
  * @since_tizen 3.0
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  */
@@ -71,9 +73,9 @@ typedef enum {
  * @since_tizen 3.0
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
- * @param [in] reader The reader handle
- * @param [in] event_type The reader event type
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] reader The reader handle
+ * @param[in] event_type The reader event type
+ * @param[in] user_data The user data passed from the callback registration function
  *
  * @see smartcard_reader_set_event_cb()
  * @see smartcard_reader_unset_event_cb()
@@ -81,7 +83,7 @@ typedef enum {
 typedef void (*smartcard_reader_event_cb)(int reader, smartcard_reader_event_type_e event_type, void *user_data);
 
 /**
- * @brief Initializes smartcard service
+ * @brief Initializes smartcard service.
  * @since_tizen 2.3.1
  * @privlevel public
  * @privilege %http://tizen.org/privilege/secureelement
@@ -91,16 +93,16 @@ typedef void (*smartcard_reader_event_cb)(int reader, smartcard_reader_event_typ
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  *
  * @see smartcard_deinitialize()
  */
-SMARTCARD_API int smartcard_initialize(void);
+int smartcard_initialize(void);
 
 /**
- * @brief Deinitializes smartcard service
+ * @brief Deinitializes smartcard service.
  * @details Releases all the resource of the smartcard service
  * @since_tizen 2.3.1
  * @privlevel public
@@ -109,33 +111,33 @@ SMARTCARD_API int smartcard_initialize(void);
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
- * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  *
  * @see smartcard_initialize()
  */
-SMARTCARD_API int smartcard_deinitialize(void);
+int smartcard_deinitialize(void);
 
 /**
- * @brief Gets the version of SIMAlliance OpenMobileAPI specification
+ * @brief Gets the version of SIMAlliance OpenMobileAPI specification.
  * @since_tizen 3.0
  * @ingroup CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE
  *
  * @remarks The @a version must be released using free().
  *
- * @param [out] version The version of SIMAlliance OpenMobileAPI specification
+ * @param[out] version The version of SIMAlliance OpenMobileAPI specification
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_OUT_OF_MEMORY Out of memory
  *
  */
-SMARTCARD_API int smartcard_get_version(char **version);
+int smartcard_get_version(char **version);
 
 /**
  * @brief Gets the list of available Secure Element readers.
@@ -144,18 +146,18 @@ SMARTCARD_API int smartcard_get_version(char **version);
  *
  * @remarks readers must be released using free().
  *
- * @param [out] readers List of readers
- * @param [out] length The number of readers
+ * @param[out] readers List of readers
+ * @param[out] length The number of readers
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  */
-SMARTCARD_API int smartcard_get_readers(int **readers, int *length);
+int smartcard_get_readers(int **readers, int *length);
 
 /**
  * @brief Returns the name of the given reader.
@@ -163,43 +165,43 @@ SMARTCARD_API int smartcard_get_readers(int **readers, int *length);
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
  * @remarks reader_name must be released using free().
- *     @remarks If the reader is a SIM reader, then its name must be "SIM[Slot]"
- *     @remarks If the reader is a SD or micro SD reader, then its name must be "SD[slot]"
- *     @remarks If the reader is a embedded SE reader, then its name must be "eSE[slot]"
+ * @remarks If the reader is a SIM reader, then its name must be "SIM[Slot]"
+ * @remarks If the reader is a SD or micro SD reader, then its name must be "SD[slot]"
+ * @remarks If the reader is a embedded SE reader, then its name must be "eSE[slot]"
  *
- * @param [in] reader Handle to the reader
- * @param [out] reader_name The name of reader
+ * @param[in] reader Handle to the reader
+ * @param[out] reader_name The name of reader
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_get_readers()
  */
-SMARTCARD_API int smartcard_reader_get_name(int reader, char **reader_name);
+int smartcard_reader_get_name(int reader, char **reader_name);
 
 /**
  * @brief Checks if a Secure Element is present in the given reader.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
- * @param [in] reader Handle to the reader
- * @param [out] is_present True or false depending whether a secure element is present in the
+ * @param[in] reader Handle to the reader
+ * @param[out] is_present True or false depending whether a secure element is present in the
 reader - undefined when an error is returned
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_get_readers()
  */
-SMARTCARD_API int smartcard_reader_is_secure_element_present(int reader, bool *is_present);
+int smartcard_reader_is_secure_element_present(int reader, bool *is_present);
 
 /**
  * @brief Connects to a Secure Element in the given reader.
@@ -208,21 +210,21 @@ SMARTCARD_API int smartcard_reader_is_secure_element_present(int reader, bool *i
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
- * @param [in] reader Handle to the reader
- * @param [out] session Handle to the session created for the given reader
+ * @param[in] reader Handle to the reader
+ * @param[out] session Handle to the session created for the given reader
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_get_readers()
  */
-SMARTCARD_API int smartcard_reader_open_session(int reader, int *session);
+int smartcard_reader_open_session(int reader, int *session);
 
 /**
  * @brief Closes all the sessions opened on the given reader.
@@ -232,38 +234,38 @@ SMARTCARD_API int smartcard_reader_open_session(int reader, int *session);
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
- * @param [in] reader Handle to the reader
+ * @param[in] reader Handle to the reader
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_get_readers()
  */
-SMARTCARD_API int smartcard_reader_close_sessions(int reader);
+int smartcard_reader_close_sessions(int reader);
 
 /**
  * @brief Sets a callback function for receiving reader event.
  * @since_tizen 3.0
  * @ingroup CAPI_NETWORK_SMARTCARD_READER_MODULE
  *
- * @param [in] cb The reader event callback
- * @param [in] user_data The user data
+ * @param[in] cb The reader event callback
+ * @param[in] user_data The user data
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_reader_unset_event_cb()
  */
-SMARTCARD_API int smartcard_reader_set_event_cb(smartcard_reader_event_cb cb, void *user_data);
+int smartcard_reader_set_event_cb(smartcard_reader_event_cb cb, void *user_data);
 
 /**
  * @brief Unsets the reader event callback function.
@@ -272,31 +274,31 @@ SMARTCARD_API int smartcard_reader_set_event_cb(smartcard_reader_event_cb cb, vo
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  *
  * @see smartcard_reader_set_event_cb()
  */
-SMARTCARD_API int smartcard_reader_unset_event_cb(void);
+int smartcard_reader_unset_event_cb(void);
 
 /**
  * @brief Gets the reader that provides the given session.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
- * @param [in] session Handle to the session
- * @param [out] reader Reader handle that provides the given session
+ * @param[in] session Handle to the session
+ * @param[out] reader Reader handle that provides the given session
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_get_reader(int session, int *reader);
+int smartcard_session_get_reader(int session, int *reader);
 
 /**
  * @brief Gets the Answer to Reset(ATR) of this Secure Element.
@@ -308,21 +310,21 @@ SMARTCARD_API int smartcard_session_get_reader(int session, int *reader);
  * @remarks atr must be released using free().
  * @remarks If the Answer to Reset(ATR) for this Secure Element is not available the returned length is set to zero and return value is Success.
  *
- * @param [in] session Handle to the session
- * @param [out] atr Byte array to retrieve the Answer to Reset(ATR)
- * @param [out] length The length of atr
+ * @param[in] session Handle to the session
+ * @param[out] atr Byte array to retrieve the Answer to Reset(ATR)
+ * @param[out] length The length of atr
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
- * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
- * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_get_atr(int session, unsigned char **atr, int *length);
+int smartcard_session_get_atr(int session, unsigned char **atr, int *length);
 
 /**
  * @brief Closes the connection with the Secure Element.
@@ -332,39 +334,39 @@ SMARTCARD_API int smartcard_session_get_atr(int session, unsigned char **atr, in
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
- * @param [in] session handle to the session
+ * @param[in] session handle to the session
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_close(int session);
+int smartcard_session_close(int session);
 
 /**
  * @brief Checks if the given session is closed.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
- * @param [in] session Handle to the session
- * @param [out] is_closed True or false depending on the session state
+ * @param[in] session Handle to the session
+ * @param[out] is_closed True or false depending on the session state
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_is_closed(int session, bool *is_closed);
+int smartcard_session_is_closed(int session, bool *is_closed);
 
 /**
  * @brief Closes any channel opened on the given session.
@@ -373,20 +375,20 @@ SMARTCARD_API int smartcard_session_is_closed(int session, bool *is_closed);
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
- * @param [in] session Handle to the session
+ * @param[in] session Handle to the session
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_close_channels(int session);
+int smartcard_session_close_channels(int session);
 
 /**
  * @brief Gets an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has number 0).
@@ -396,60 +398,60 @@ SMARTCARD_API int smartcard_session_close_channels(int session);
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
  * @remarks ex) unsigned char aid[] = {0xA0, 0x00, 0x00, 0x00, 0x63, 0x50, 0x4B, 0x43, 0x53, 0x2D, 0x31, 0x35};
- * @remarks If the Application ID(AID) is null, it means no Applet is to be selected on this channel and the default Applet is used.
+ * @remarks If the Application ID (AID) is null, it means no Applet is to be selected on this channel and the default Applet is used.
  * @remarks Opening of the basic channel to a specific applet is NOT allowed for UICC.
  *
- * @param [in] session Handle to the session
- * @param [in] aid Byte array containing the Application ID(AID) to be selected on the given channel
- * @param [in] aid_len Size of byte array or 0 when no SELECT should be executed
- * @param [in] P2 P2 byte of the SELECT command if executed
- * @param [out] channel Handle of the basic channel
+ * @param[in] session Handle to the session
+ * @param[in] aid Byte array containing the Application ID (AID) to be selected on the given channel
+ * @param[in] aid_len Size of byte array or 0 when no SELECT should be executed
+ * @param[in] P2 P2 byte of the SELECT command if executed
+ * @param[out] channel Handle of the basic channel
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_CHANNEL_NOT_AVAILABLE No channel available
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_CHANNEL_NOT_AVAILABLE No channel available
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NO_SUCH_ELEMENT No such element error
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_open_basic_channel(int session, unsigned char *aid, int aid_len, unsigned char P2, int *channel);
+int smartcard_session_open_basic_channel(int session, unsigned char *aid, int aid_len, unsigned char P2, int *channel);
 
 /**
- * @brief Open a logical channel with the Secure Element, selecting the Applet represented by the given Application ID(AID).
+ * @brief Opens a logical channel with the Secure Element, selecting the Applet represented by the given Application ID (AID).
  * @since_tizen 2.3.1
  * @privlevel public
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE
  *
  * @remarks ex) unsigned char aid[] = {0xA0, 0x00, 0x00, 0x00, 0x63, 0x50, 0x4B, 0x43, 0x53, 0x2D, 0x31, 0x35};
- * @remarks If the Application ID(AID) is null, it means no Applet is to be selected on this channel and the default Applet is used.
+ * @remarks If the Application ID (AID) is null, it means no Applet is to be selected on this channel and the default Applet is used.
  *
- * @param [in] session Handle to the session
- * @param [in] aid Byte array containing the Application ID(AID) to be selected on the given channel
- * @param [in] aid_len Size of byte array or 0 when no SELECT should be executed
- * @param [in] P2 P2 byte of the SELECT command if executed
- * @param [out] channel Handle of the new logical channel
+ * @param[in] session Handle to the session
+ * @param[in] aid Byte array containing the Application ID (AID) to be selected on the given channel
+ * @param[in] aid_len Size of byte array or 0 when no SELECT should be executed
+ * @param[in] P2 P2 byte of the SELECT command if executed
+ * @param[out] channel Handle of the new logical channel
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_CHANNEL_NOT_AVAILABLE No channel available
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_CHANNEL_NOT_AVAILABLE No channel available
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NO_SUCH_ELEMENT No such element error
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_reader_open_session()
  */
-SMARTCARD_API int smartcard_session_open_logical_channel(int session, unsigned char *aid, int aid_len, unsigned char P2, int *channel);
+int smartcard_session_open_logical_channel(int session, unsigned char *aid, int aid_len, unsigned char P2, int *channel);
 
 /**
  * @brief Closes the given channel to the Secure Element.
@@ -458,61 +460,61 @@ SMARTCARD_API int smartcard_session_open_logical_channel(int session, unsigned c
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
- * @param [in] channel Handle to the channel
+ * @param[in] channel Handle to the channel
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_close(int channel);
+int smartcard_channel_close(int channel);
 
 /**
  * @brief Checks if the given channel is the basic channel.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
- * @param [in] channel Handle to the channel
- * @param [out] is_basic_channel True or false depending on the channel type
+ * @param[in] channel Handle to the channel
+ * @param[out] is_basic_channel True or false depending on the channel type
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_is_basic_channel(int channel, bool *is_basic_channel);
+int smartcard_channel_is_basic_channel(int channel, bool *is_basic_channel);
 
 /**
  * @brief Checks if the given channel is closed.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
- * @param [in] channel Handle to the channel
- * @param [out] is_closed True or false depending on the channel state
+ * @param[in] channel Handle to the channel
+ * @param[out] is_closed True or false depending on the channel state
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_is_closed(int channel, bool *is_closed);
+int smartcard_channel_is_closed(int channel, bool *is_closed);
 
 /**
  * @brief Gets the response to the select command.
@@ -521,41 +523,41 @@ SMARTCARD_API int smartcard_channel_is_closed(int channel, bool *is_closed);
  *
  * @remarks select_resp must be released using free().
  *
- * @param [in] channel Handle to the channel
- * @param [out] select_resp Byte array to retrieve the SELECT response
- * @param [out] length The length of select_resp
+ * @param[in] channel Handle to the channel
+ * @param[out] select_resp Byte array to retrieve the SELECT response
+ * @param[out] length The length of select_resp
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_get_select_response(int channel, unsigned char **select_resp, int *length);
+int smartcard_channel_get_select_response(int channel, unsigned char **select_resp, int *length);
 
 /**
  * @brief Gets the session that has opened the given channel.
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
- * @param [in] channel Handle to the channel
- * @param [out] session Session handle of the given channel
+ * @param[in] channel Handle to the channel
+ * @param[out] session Session handle of the given channel
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_get_session(int channel, int *session);
+int smartcard_channel_get_session(int channel, int *session);
 
 /**
  * @brief Transmits an APDU command (as per ISO/IEC 7816-4) to the Secure Element.
@@ -569,80 +571,80 @@ SMARTCARD_API int smartcard_channel_get_session(int channel, int *session);
  * @remarks SELECT by DF Name (P1=04) are not allowed.
  * @remarks bytes with channel numbers are de-masked.
 
- * @param [in] channel Handle to the channel
- * @param [in] cmd Command APDU to be send to the secure element
- * @param [in] cmd_len Size of command APDU
- * @param [out] resp Byte array for the response APDU plus status words
- * @param [out] length The length of resp
+ * @param[in] channel Handle to the channel
+ * @param[in] cmd Command APDU to be send to the secure element
+ * @param[in] cmd_len Size of command APDU
+ * @param[out] resp Byte array for the response APDU plus status words
+ * @param[out] length The length of resp
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_ILLEGAL_STATE Illegal state of execution error
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_transmit(int channel, unsigned char *cmd, int cmd_len, unsigned char **resp, int *length);
+int smartcard_channel_transmit(int channel, unsigned char *cmd, int cmd_len, unsigned char **resp, int *length);
 
 /**
- * @brief Helper function to retrieves the response APDU of the previous transmit() call
+ * @brief Retrieves the response APDU of the previous transmit() call (helper function).
  * @since_tizen 2.3.1
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
  * @remarks resp must be released using free().
  *
- * @param [in] channel Handle to the channel
- * @param [out] resp Byte array for the response APDU plus status words
- * @param [out] length The length of resp
+ * @param[in] channel Handle to the channel
+ * @param[out] resp Byte array for the response APDU plus status words
+ * @param[out] length The length of resp
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_ILLEGAL_STATE Illegal state of execution error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_transmit_retrieve_response(int channel, unsigned char **resp, int *length);
+int smartcard_channel_transmit_retrieve_response(int channel, unsigned char **resp, int *length);
 
 /**
- * @brief Performs a selection of the next Applet on the given channel that matches to the partial Application ID(AID)
+ * @brief Performs a selection of the next Applet on the given channel that matches to the partial Application ID (AID).
  * @since_tizen 2.3.1
  * @privlevel public
  * @privilege %http://tizen.org/privilege/secureelement
  * @ingroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE
  *
- * @param [in] channel Handle to the channel
- * @param [out] is_success True or false depending whether another applet with the partial Application ID(AID)
+ * @param[in] channel Handle to the channel
+ * @param[out] is_success True or false depending whether another applet with the partial Application ID (AID)
 could be selected on the given channel
 
  * @return 0 on success, otherwise a negative error value.
  * @retval #SMARTCARD_ERROR_NONE Successful
- * @retval #SMARTCARD_ERROR_GENERAL    A general error occurred
+ * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
+ * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SMARTCARD_ERROR_INVALID_PARAMETER Invalid function parameter
+ * @retval #SMARTCARD_ERROR_GENERAL A general error occurred
  * @retval #SMARTCARD_ERROR_ILLEGAL_STATE Illegal state of execution error
  * @retval #SMARTCARD_ERROR_OPERATION_NOT_SUPPORTED Operation not supported from SE
  * @retval #SMARTCARD_ERROR_IO_ERROR I/O error
  * @retval #SMARTCARD_ERROR_NOT_INITIALIZED Smartcard service not initialized
- * @retval #SMARTCARD_ERROR_NOT_SUPPORTED Not supported
- * @retval #SMARTCARD_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see smartcard_session_open_basic_channel()
  * @see smartcard_session_open_logical_channel()
  */
-SMARTCARD_API int smartcard_channel_select_next(int channel, bool *is_success);
+int smartcard_channel_select_next(int channel, bool *is_success);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
+#endif /* __TIZEN_CAPI_NETWORK_SMARTCARD_H__ */
old mode 100755 (executable)
new mode 100644 (file)
index ed0fad1..c3ed73e
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __smartcard_debug_h__
-#define __smartcard_debug_h__
+#ifndef __TIZEN_CAPI_NETWORK_SMARTCARD_DEBUG_H__
+#define __TIZEN_CAPI_NETWORK_SMARTCARD_DEBUG_H__
 
 #define COLOR_BLACK "\033[0;30m"
 #define COLOR_RED   "\033[0;31m"
@@ -73,4 +73,4 @@
                } \
        } while (0)
 
-#endif
+#endif /* __TIZEN_CAPI_NETWORK_SMARTCARD_DEBUG_H__ */
\ No newline at end of file