[Pcsclite-cvs-commit] r2124 - trunk/PCSC/src/PCSC
Ludovic Rousseau
rousseau at costa.debian.org
Mon Aug 7 14:18:53 UTC 2006
Author: rousseau
Date: 2006-08-07 14:18:52 +0000 (Mon, 07 Aug 2006)
New Revision: 2124
Modified:
trunk/PCSC/src/PCSC/pcsclite.h.in
Log:
Transform C comments into Doxygen comments
Modified: trunk/PCSC/src/PCSC/pcsclite.h.in
===================================================================
--- trunk/PCSC/src/PCSC/pcsclite.h.in 2006-08-07 10:05:40 UTC (rev 2123)
+++ trunk/PCSC/src/PCSC/pcsclite.h.in 2006-08-07 14:18:52 UTC (rev 2124)
@@ -33,7 +33,7 @@
typedef SCARDHANDLE *PSCARDHANDLE;
typedef SCARDHANDLE *LPSCARDHANDLE;
-#define MAX_ATR_SIZE 33 /* Maximum ATR size */
+#define MAX_ATR_SIZE 33 /**< Maximum ATR size */
typedef struct
{
@@ -103,62 +103,62 @@
#define SCARD_E_NO_SERVICE 0x8010001D
#define SCARD_E_SERVICE_STOPPED 0x8010001E
-#define SCARD_SCOPE_USER 0x0000 /* Scope in user space */
-#define SCARD_SCOPE_TERMINAL 0x0001 /* Scope in terminal */
-#define SCARD_SCOPE_SYSTEM 0x0002 /* Scope in system */
+#define SCARD_SCOPE_USER 0x0000 /**< Scope in user space */
+#define SCARD_SCOPE_TERMINAL 0x0001 /**< Scope in terminal */
+#define SCARD_SCOPE_SYSTEM 0x0002 /**< Scope in system */
-#define SCARD_PROTOCOL_UNSET 0x0000 /* protocol not set */
-#define SCARD_PROTOCOL_T0 0x0001 /* T=0 active protocol. */
-#define SCARD_PROTOCOL_T1 0x0002 /* T=1 active protocol. */
-#define SCARD_PROTOCOL_RAW 0x0004 /* Raw active protocol. */
-#define SCARD_PROTOCOL_T15 0x0008 /* T=15 protocol. */
+#define SCARD_PROTOCOL_UNSET 0x0000 /**< protocol not set */
+#define SCARD_PROTOCOL_T0 0x0001 /**< T=0 active protocol. */
+#define SCARD_PROTOCOL_T1 0x0002 /**< T=1 active protocol. */
+#define SCARD_PROTOCOL_RAW 0x0004 /**< Raw active protocol. */
+#define SCARD_PROTOCOL_T15 0x0008 /**< T=15 protocol. */
-#define SCARD_PROTOCOL_ANY (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1) /* IFD determines prot. */
+#define SCARD_PROTOCOL_ANY (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1) /**< IFD determines prot. */
-#define SCARD_SHARE_EXCLUSIVE 0x0001 /* Exclusive mode only */
-#define SCARD_SHARE_SHARED 0x0002 /* Shared mode only */
-#define SCARD_SHARE_DIRECT 0x0003 /* Raw mode only */
+#define SCARD_SHARE_EXCLUSIVE 0x0001 /**< Exclusive mode only */
+#define SCARD_SHARE_SHARED 0x0002 /**< Shared mode only */
+#define SCARD_SHARE_DIRECT 0x0003 /**< Raw mode only */
-#define SCARD_LEAVE_CARD 0x0000 /* Do nothing on close */
-#define SCARD_RESET_CARD 0x0001 /* Reset on close */
-#define SCARD_UNPOWER_CARD 0x0002 /* Power down on close */
-#define SCARD_EJECT_CARD 0x0003 /* Eject on close */
+#define SCARD_LEAVE_CARD 0x0000 /**< Do nothing on close */
+#define SCARD_RESET_CARD 0x0001 /**< Reset on close */
+#define SCARD_UNPOWER_CARD 0x0002 /**< Power down on close */
+#define SCARD_EJECT_CARD 0x0003 /**< Eject on close */
-#define SCARD_UNKNOWN 0x0001 /* Unknown state */
-#define SCARD_ABSENT 0x0002 /* Card is absent */
-#define SCARD_PRESENT 0x0004 /* Card is present */
-#define SCARD_SWALLOWED 0x0008 /* Card not powered */
-#define SCARD_POWERED 0x0010 /* Card is powered */
-#define SCARD_NEGOTIABLE 0x0020 /* Ready for PTS */
-#define SCARD_SPECIFIC 0x0040 /* PTS has been set */
+#define SCARD_UNKNOWN 0x0001 /**< Unknown state */
+#define SCARD_ABSENT 0x0002 /**< Card is absent */
+#define SCARD_PRESENT 0x0004 /**< Card is present */
+#define SCARD_SWALLOWED 0x0008 /**< Card not powered */
+#define SCARD_POWERED 0x0010 /**< Card is powered */
+#define SCARD_NEGOTIABLE 0x0020 /**< Ready for PTS */
+#define SCARD_SPECIFIC 0x0040 /**< PTS has been set */
-#define SCARD_STATE_UNAWARE 0x0000 /* App wants status */
-#define SCARD_STATE_IGNORE 0x0001 /* Ignore this reader */
-#define SCARD_STATE_CHANGED 0x0002 /* State has changed */
-#define SCARD_STATE_UNKNOWN 0x0004 /* Reader unknown */
-#define SCARD_STATE_UNAVAILABLE 0x0008 /* Status unavailable */
-#define SCARD_STATE_EMPTY 0x0010 /* Card removed */
-#define SCARD_STATE_PRESENT 0x0020 /* Card inserted */
-#define SCARD_STATE_ATRMATCH 0x0040 /* ATR matches card */
-#define SCARD_STATE_EXCLUSIVE 0x0080 /* Exclusive Mode */
-#define SCARD_STATE_INUSE 0x0100 /* Shared Mode */
-#define SCARD_STATE_MUTE 0x0200 /* Unresponsive card */
-#define SCARD_STATE_UNPOWERED 0x0400 /* Unpowered card */
+#define SCARD_STATE_UNAWARE 0x0000 /**< App wants status */
+#define SCARD_STATE_IGNORE 0x0001 /**< Ignore this reader */
+#define SCARD_STATE_CHANGED 0x0002 /**< State has changed */
+#define SCARD_STATE_UNKNOWN 0x0004 /**< Reader unknown */
+#define SCARD_STATE_UNAVAILABLE 0x0008 /**< Status unavailable */
+#define SCARD_STATE_EMPTY 0x0010 /**< Card removed */
+#define SCARD_STATE_PRESENT 0x0020 /**< Card inserted */
+#define SCARD_STATE_ATRMATCH 0x0040 /**< ATR matches card */
+#define SCARD_STATE_EXCLUSIVE 0x0080 /**< Exclusive Mode */
+#define SCARD_STATE_INUSE 0x0100 /**< Shared Mode */
+#define SCARD_STATE_MUTE 0x0200 /**< Unresponsive card */
+#define SCARD_STATE_UNPOWERED 0x0400 /**< Unpowered card */
#endif
-/* PC/SC Lite specific extensions */
+/** PC/SC Lite specific extensions */
#define SCARD_W_INSERTED_CARD 0x8010006A
#define SCARD_E_UNSUPPORTED_FEATURE 0x8010001F
-#define SCARD_SCOPE_GLOBAL 0x0003 /* Scope is global */
+#define SCARD_SCOPE_GLOBAL 0x0003 /**< Scope is global */
-#define SCARD_RESET 0x0001 /* Card was reset */
-#define SCARD_INSERTED 0x0002 /* Card was inserted */
-#define SCARD_REMOVED 0x0004 /* Card was removed */
+#define SCARD_RESET 0x0001 /**< Card was reset */
+#define SCARD_INSERTED 0x0002 /**< Card was inserted */
+#define SCARD_REMOVED 0x0004 /**< Card was removed */
-#define BLOCK_STATUS_RESUME 0x00FF /* Normal resume */
-#define BLOCK_STATUS_BLOCKING 0x00FA /* Function is blocking */
+#define BLOCK_STATUS_RESUME 0x00FF /**< Normal resume */
+#define BLOCK_STATUS_BLOCKING 0x00FA /**< Function is blocking */
#define PCSCLITE_CONFIG_DIR "@confdir_exp@"
@@ -172,47 +172,47 @@
#define PCSCLITE_PUBSHM_FILE PCSCLITE_IPC_DIR "/pcscd.pub"
#define PCSCLITE_CSOCK_NAME PCSCLITE_IPC_DIR "/pcscd.comm"
-#define PCSCLITE_SVC_IDENTITY 0x01030000 /* Service ID */
+#define PCSCLITE_SVC_IDENTITY 0x01030000 /**< Service ID */
#ifndef INFINITE
-#define INFINITE 0xFFFFFFFF /* Infinite timeout */
+#define INFINITE 0xFFFFFFFF /**< Infinite timeout */
#endif
-#define PCSCLITE_INFINITE_TIMEOUT 4320000 /* 50 day infinite t/o */
+#define PCSCLITE_INFINITE_TIMEOUT 4320000 /**< 50 day infinite t/o */
-#define PCSCLITE_VERSION_NUMBER "@VERSION@" /* Current version */
-#define PCSCLITE_CLIENT_ATTEMPTS 120 /* Attempts to reach sv */
-#define PCSCLITE_MCLIENT_ATTEMPTS 20 /* Attempts to reach sv */
-#define PCSCLITE_STATUS_POLL_RATE 400000 /* Status polling rate */
-#define PCSCLITE_MSG_KEY_LEN 16 /* App ID key length */
-#define PCSCLITE_RW_ATTEMPTS 100 /* Attempts to rd/wrt */
+#define PCSCLITE_VERSION_NUMBER "@VERSION@" /**< Current version */
+#define PCSCLITE_CLIENT_ATTEMPTS 120 /**< Attempts to reach sv */
+#define PCSCLITE_MCLIENT_ATTEMPTS 20 /**< Attempts to reach sv */
+#define PCSCLITE_STATUS_POLL_RATE 400000 /**< Status polling rate */
+#define PCSCLITE_MSG_KEY_LEN 16 /**< App ID key length */
+#define PCSCLITE_RW_ATTEMPTS 100 /**< Attempts to rd/wrt */
-/* Maximum applications */
+/** Maximum applications */
#define PCSCLITE_MAX_APPLICATIONS 16
-/* Maximum contexts by application */
+/** Maximum contexts by application */
#define PCSCLITE_MAX_APPLICATION_CONTEXTS 16
-/* Maximum of applications contexts that pcscd can accept */
+/** Maximum of applications contexts that pcscd can accept */
#define PCSCLITE_MAX_APPLICATIONS_CONTEXTS \
PCSCLITE_MAX_APPLICATIONS * PCSCLITE_MAX_APPLICATION_CONTEXTS
-/* Maximum channels on a reader context */
+/** Maximum channels on a reader context */
#define PCSCLITE_MAX_READER_CONTEXT_CHANNELS 16
-/* Maximum channels on an application context */
+/** Maximum channels on an application context */
#define PCSCLITE_MAX_APPLICATION_CONTEXT_CHANNELS 16
-/* Maximum readers context (a slot is count as a reader) */
+/** Maximum readers context (a slot is count as a reader) */
#define PCSCLITE_MAX_READERS_CONTEXTS 16
/* PCSCLITE_MAX_READERS is deprecated
* use PCSCLITE_MAX_READERS_CONTEXTS instead */
/* extern int PCSCLITE_MAX_READERS __attribute__ ((deprecated)); */
-#define PCSCLITE_MAX_THREADS 16 /* Stat change threads */
-#define PCSCLITE_STATUS_WAIT 200000 /* Status Change Sleep */
-#define PCSCLITE_TRANSACTION_TIMEOUT 40 /* Transaction timeout */
+#define PCSCLITE_MAX_THREADS 16 /**< Stat change threads */
+#define PCSCLITE_STATUS_WAIT 200000 /**< Status Change Sleep */
+#define PCSCLITE_TRANSACTION_TIMEOUT 40 /**< Transaction timeout */
#define MAX_READERNAME 52
#define MAX_LIBNAME 100
#define MAX_DEVICENAME 255
#ifndef SCARD_ATR_LENGTH
-#define SCARD_ATR_LENGTH MAX_ATR_SIZE /* Maximum ATR size */
+#define SCARD_ATR_LENGTH MAX_ATR_SIZE /**< Maximum ATR size */
#endif
/*
@@ -220,10 +220,10 @@
* The max message size must be at least large enough
* to accomodate the transmit_struct
*/
-#define PCSCLITE_MAX_MESSAGE_SIZE 2048 /* Transport msg len */
-#define MAX_BUFFER_SIZE 264 /* Maximum Tx/Rx Buffer for short APDU */
-#define MAX_BUFFER_SIZE_EXTENDED (4 + 3 + (1<<16) + 3) /* enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */
-#define PCSCLITE_SERVER_ATTEMPTS 5 /* Attempts to reach cl */
+#define PCSCLITE_MAX_MESSAGE_SIZE 2048 /**< Transport msg len */
+#define MAX_BUFFER_SIZE 264 /**< Maximum Tx/Rx Buffer for short APDU */
+#define MAX_BUFFER_SIZE_EXTENDED (4 + 3 + (1<<16) + 3) /**< enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */
+#define PCSCLITE_SERVER_ATTEMPTS 5 /**< Attempts to reach cl */
/*
* Gets a stringified error response
More information about the Pcsclite-cvs-commit
mailing list