[Pcsclite-cvs-commit] r1695 - trunk/PCSC/src

Ludovic Rousseau rousseau at costa.debian.org
Sat Oct 29 16:27:38 UTC 2005


Author: rousseau
Date: 2005-10-29 16:27:33 +0000 (Sat, 29 Oct 2005)
New Revision: 1695

Modified:
   trunk/PCSC/src/tokenparser.l
   trunk/PCSC/src/winscard_clnt.c
   trunk/PCSC/src/winscard_msg.c
   trunk/PCSC/src/winscard_msg.h
   trunk/PCSC/src/winscard_msg_srv.c
   trunk/PCSC/src/winscard_svc.c
Log:
correct some Doxygen warnings


Modified: trunk/PCSC/src/tokenparser.l
===================================================================
--- trunk/PCSC/src/tokenparser.l	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/tokenparser.l	2005-10-29 16:27:33 UTC (rev 1695)
@@ -10,6 +10,12 @@
  * $Id$
  */
 
+/**
+ * @file
+ * @brief provides LTPBundleFindValueWithKey() function on non-MacOS X
+ * platforms
+ */
+
 %{
 
 #include "config.h"
@@ -94,6 +100,17 @@
 {
 }
 
+/**
+ * Find a key in a configuration file
+ *
+ * @param fileName file name
+ * @param tokenKey key value
+ * @param[out] tokenValue token value (if key found)
+ * @param tokenIndice indice of the desired key
+ * @retval -1 configuration file not found
+ * @retval 0 OK
+ * @retval 1 key not found
+ */
 int LTPBundleFindValueWithKey(char *fileName, char *tokenKey,
                               char *tokenValue, int tokenIndice)
 {

Modified: trunk/PCSC/src/winscard_clnt.c
===================================================================
--- trunk/PCSC/src/winscard_clnt.c	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/winscard_clnt.c	2005-10-29 16:27:33 UTC (rev 1695)
@@ -2726,7 +2726,7 @@
  * This function cancels all pending blocking requests on the
  * \c SCardGetStatusChange() function.
  *
- * @param[in] hCard Connection context to the PC/SC Resource Manager.
+ * @param[in] hContext Connection context to the PC/SC Resource Manager.
  *
  * @return Error code.
  * @retval SCARD_S_SUCCESS Successful.

Modified: trunk/PCSC/src/winscard_msg.c
===================================================================
--- trunk/PCSC/src/winscard_msg.c	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/winscard_msg.c	2005-10-29 16:27:33 UTC (rev 1695)
@@ -43,7 +43,7 @@
 #include "misc.h"
 
 /**
- * @brief Wrapper for the \c SHMMessageReceive() function.
+ * @brief Wrapper for the SHMMessageReceive() function.
  *
  * Called by clients to read the server responses.
  *
@@ -51,8 +51,7 @@
  * @param[in] dwClientID Client socket handle.
  * @param[in] blockamount Timeout in milliseconds.
  *
- * @return Error code.
- * @retval @see SHMMessageReceive().
+ * @return Same error codes as SHMMessageReceive().
  */
 INTERNAL int SHMClientRead(psharedSegmentMsg msgStruct, DWORD dwClientID, int blockamount)
 {
@@ -67,7 +66,6 @@
  *
  * @param[out] pdwClientID Client Connection ID.
  * 
- * @return Error code.
  * @retval 0 Success.
  * @retval -1 Can not create the socket.
  * @retval -1 The socket can not open a connection.
@@ -115,7 +113,6 @@
  *
  * @param[in] dwClientID Client socket handle to be closed.
  *
- * @return Error code.
  * @retval 0 Success.
  */
 INTERNAL int SHMClientCloseSession(DWORD dwClientID)
@@ -132,6 +129,11 @@
  * @param[in] msgStruct Message to be sent.
  * @param[in] filedes Socket handle.
  * @param[in] blockAmount Timeout in milliseconds.
+ *
+ * @retval 0 Success
+ * @retval -1 Timeout.
+ * @retval -1 Socket is closed.
+ * @retval -1 A signal was received.
  */
 INTERNAL int SHMMessageSend(psharedSegmentMsg msgStruct, int filedes,
 	int blockAmount)
@@ -254,7 +256,6 @@
  * @param[in] filedes Socket handle.
  * @param[in] blockAmount Timeout in milliseconds.
  *
- * @return Error code.
  * @retval 0 Success.
  * @retval -1 Timeout.
  * @retval -1 Socket is closed.
@@ -373,7 +374,7 @@
 }
 
 /**
- * @brief Wrapper for the \c SHMMessageSend() function.
+ * @brief Wrapper for the SHMMessageSend() function.
  *
  * Called by clients to send messages to the server.
  * The parameters \p command and \p data are set in the \c sharedSegmentMsg
@@ -385,8 +386,7 @@
  * @param[in] blockAmount Timeout to the operation in ms.
  * @param[in] data Data to be sent.
  *
- * @return Error code.
- * @retval @see SHMMessageSend().
+ * @return Same error codes as SHMMessageSend().
  */
 INTERNAL int WrapSHMWrite(unsigned int command, DWORD dwClientID,
 	unsigned int size, unsigned int blockAmount, void *data)

Modified: trunk/PCSC/src/winscard_msg.h
===================================================================
--- trunk/PCSC/src/winscard_msg.h	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/winscard_msg.h	2005-10-29 16:27:33 UTC (rev 1695)
@@ -11,7 +11,7 @@
 
 /**
  * @file
- * @brief This defines some structures and #defines to be used over
+ * @brief This defines some structures and \#defines to be used over
  * the transport layer.
  */
 

Modified: trunk/PCSC/src/winscard_msg_srv.c
===================================================================
--- trunk/PCSC/src/winscard_msg_srv.c	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/winscard_msg_srv.c	2005-10-29 16:27:33 UTC (rev 1695)
@@ -157,7 +157,7 @@
  * This is called by the Server's function \c SVCServiceRunLoop().
  *
  * @param[out] pdwClientID Connection ID used to reference the Client.
- * @param[in] blockTime Timeout (not used).
+ * @param[in] blocktime Timeout (not used).
  *
  * @return Error code.
  * @retval 0 Success.

Modified: trunk/PCSC/src/winscard_svc.c
===================================================================
--- trunk/PCSC/src/winscard_svc.c	2005-10-29 15:49:32 UTC (rev 1694)
+++ trunk/PCSC/src/winscard_svc.c	2005-10-29 16:27:33 UTC (rev 1695)
@@ -213,7 +213,7 @@
 }
 
 /**
- * @Find out which message was sent by the Client and execute the right task.
+ * @brief Find out which message was sent by the Client and execute the right task.
  *
  * According to the command type sent by the client (\c pcsc_msg_commands),
  * cast the message data to the correct struct so that is can be demarshalled.
@@ -225,7 +225,7 @@
  * \c control_struct \c getset_struct.
  *
  * @param[in] msgStruct Message to be demarshalled and executed.
- * param[in] dwContextIndex 
+ * @param[in] dwContextIndex 
  */
 LONG MSGFunctionDemarshall(psharedSegmentMsg msgStruct, DWORD dwContextIndex)
 {




More information about the Pcsclite-cvs-commit mailing list