[Pcsclite-cvs-commit] r4668 - /trunk/PCSC/src/winscard_clnt.c

[rousseau at users.alioth.debian.org]

Author: rousseau
Date: Thu Jan 14 13:20:43 2010
New Revision: 4668

URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=4668
Log:
Doxygen: update SCardGetStatusChange() doc. The function returns on any
events, not just those specified in dwCurrentState

Modified:
    trunk/PCSC/src/winscard_clnt.c

Modified: trunk/PCSC/src/winscard_clnt.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/winscard_clnt.c?rev=4668&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_clnt.c (original)
+++ trunk/PCSC/src/winscard_clnt.c Thu Jan 14 13:20:43 2010
@@ -1733,10 +1733,13 @@
 }
 
 /**
- * @brief This function receives a structure or list of structures containing
- * reader names. It then blocks for a change in state to occur on any of the
- * OR'd values contained in \p dwCurrentState for a maximum blocking time of
- * \p dwTimeout or forever if \ref INFINITE is used.
+ * @brief This function blocks execution until the current availability
+ * of the cards in a specific set of readers changes. 
+ *
+ * This function receives a structure or list of structures containing
+ * reader names. It then blocks for a change in state to occur for a
+ * maximum blocking time of \p dwTimeout or forever if \ref INFINITE is
+ * used.
  *
  * The new event state will be contained in \p dwEventState. A status change
  * might be a card insertion or removal event, a change in ATR, etc.