[Pcsclite-cvs-commit] CVS PCSC/src/PCSC

CVS User rousseau ludovic.rousseau@free.fr
Tue, 12 Apr 2005 12:09:18 +0000


Update of /cvsroot/pcsclite/PCSC/src/PCSC
In directory haydn:/tmp/cvs-serv11706/src/PCSC

Modified Files:
	debuglog.h dyn_generic.h ifdhandler.h parser.h pcsclite.h.in 
	sys_generic.h thread_generic.h winscard.h wintypes.h 
Log Message:
add (some) Doxygen documentation

Thanks to Luiz Reuter Silva Torro for the patch


--- /cvsroot/pcsclite/PCSC/src/PCSC/debuglog.h	2005/03/01 09:15:47	1.21
+++ /cvsroot/pcsclite/PCSC/src/PCSC/debuglog.h	2005/04/12 12:09:16	1.22
@@ -1,6 +1,4 @@
 /*
- * This handles debugging.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999-2004
@@ -8,27 +6,29 @@
  * Copyright (C) 1999-2005
  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
  *
- * $Id: debuglog.h,v 1.21 2005/03/01 09:15:47 rousseau Exp $
+ * $Id: debuglog.h,v 1.22 2005/04/12 12:09:16 rousseau Exp $
  */
 
-/*
- * log message is sent to syslog or stderr depending on --foreground
+/**
+ * @file
+ * @brief This handles debugging.
+ *
+ * @note log message is sent to syslog or stderr depending on --foreground
  * command line argument
  *
+ * @test
+ * @code
  * Log1(priority, "text");
  *  log "text" with priority level priority
- *
  * Log2(priority, "text: %d", 1234);
  *  log "text: 1234"
  * the format string can be anything printf() can understand
- *
  * Log3(priority, "text: %d %d", 1234, 5678);
  *  log "text: 1234 5678"
  * the format string can be anything printf() can understand
- *
  * LogXxd(priority, msg, buffer, size);
  *  log "msg" + a hex dump of size bytes of buffer[]
- *
+ * @endcode
  */
 
 #ifndef __debuglog_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/dyn_generic.h	2003/10/18 17:19:36	1.3
+++ /cvsroot/pcsclite/PCSC/src/PCSC/dyn_generic.h	2005/04/12 12:09:16	1.4
@@ -1,12 +1,15 @@
 /*
- * This abstracts dynamic library loading functions.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999
  *  David Corcoran <corcoran@linuxnet.com>
  *
- * $Id: dyn_generic.h,v 1.3 2003/10/18 17:19:36 aet-guest Exp $
+ * $Id: dyn_generic.h,v 1.4 2005/04/12 12:09:16 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This abstracts dynamic library loading functions.
  */
 
 #ifndef __dyn_generic_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/ifdhandler.h	2004/08/06 12:12:19	1.15
+++ /cvsroot/pcsclite/PCSC/src/PCSC/ifdhandler.h	2005/04/12 12:09:16	1.16
@@ -1,13 +1,16 @@
 /*
- * This provides reader specific low-level calls.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999-2004
  *  David Corcoran <corcoran@linuxnet.com>
  *  Damien Sauveron <damien.sauveron@labri.fr>
  *
- * $Id: ifdhandler.h,v 1.15 2004/08/06 12:12:19 rousseau Exp $
+ * $Id: ifdhandler.h,v 1.16 2005/04/12 12:09:16 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This provides reader specific low-level calls.
  */
 
 #ifndef _ifd_handler_h_
--- /cvsroot/pcsclite/PCSC/src/PCSC/parser.h	2003/10/21 20:00:53	1.5
+++ /cvsroot/pcsclite/PCSC/src/PCSC/parser.h	2005/04/12 12:09:16	1.6
@@ -1,13 +1,16 @@
 /*
- * Reads lexical config files and updates database.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 2003
  *  Toni Andjelkovic <toni@soth.at>
  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
  *
- * $Id: parser.h,v 1.5 2003/10/21 20:00:53 aet-guest Exp $
+ * $Id: parser.h,v 1.6 2005/04/12 12:09:16 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief Reads lexical config files and updates database.
  */
 
 #ifndef __parser_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/pcsclite.h.in	2004/08/24 21:46:57	1.47
+++ /cvsroot/pcsclite/PCSC/src/PCSC/pcsclite.h.in	2005/04/12 12:09:16	1.48
@@ -1,13 +1,16 @@
 /*
- * This keeps a list of defines for pcsc-lite.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999-2004
  *  David Corcoran <corcoran@linuxnet.com>
  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
  *
- * $Id: pcsclite.h.in,v 1.47 2004/08/24 21:46:57 rousseau Exp $
+ * $Id: pcsclite.h.in,v 1.48 2005/04/12 12:09:16 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This keeps a list of defines for pcsc-lite.
  */
 
 #ifndef __pcsclite_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/sys_generic.h	2005/01/11 20:44:54	1.8
+++ /cvsroot/pcsclite/PCSC/src/PCSC/sys_generic.h	2005/04/12 12:09:18	1.9
@@ -1,12 +1,15 @@
 /*
- * This handles abstract system level calls.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999
  *  David Corcoran <corcoran@linuxnet.com>
  *
- * $Id: sys_generic.h,v 1.8 2005/01/11 20:44:54 rousseau Exp $
+ * $Id: sys_generic.h,v 1.9 2005/04/12 12:09:18 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This handles abstract system level calls.
  */
 
 #ifndef __sys_generic_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/thread_generic.h	2004/08/02 21:48:08	1.14
+++ /cvsroot/pcsclite/PCSC/src/PCSC/thread_generic.h	2005/04/12 12:09:18	1.15
@@ -1,6 +1,4 @@
 /*
- * This provides system specific thread calls.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 2000-2004
@@ -8,7 +6,12 @@
  *  Damien Sauveron <damien.sauveron@labri.fr>
  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
  *
- * $Id: thread_generic.h,v 1.14 2004/08/02 21:48:08 rousseau Exp $
+ * $Id: thread_generic.h,v 1.15 2005/04/12 12:09:18 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This provides system specific thread calls.
  */
 
 #ifndef __thread_generic_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/winscard.h	2004/08/06 12:12:19	1.13
+++ /cvsroot/pcsclite/PCSC/src/PCSC/winscard.h	2005/04/12 12:09:18	1.14
@@ -1,13 +1,16 @@
 /*
- * This handles smartcard reader communications.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999-2003
  *  David Corcoran <corcoran@linuxnet.com>
  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
  *
- * $Id: winscard.h,v 1.13 2004/08/06 12:12:19 rousseau Exp $
+ * $Id: winscard.h,v 1.14 2005/04/12 12:09:18 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This handles smartcard reader communications.
  */
 
 #ifndef __winscard_h__
--- /cvsroot/pcsclite/PCSC/src/PCSC/wintypes.h	2004/07/06 17:05:04	1.9
+++ /cvsroot/pcsclite/PCSC/src/PCSC/wintypes.h	2005/04/12 12:09:18	1.10
@@ -1,12 +1,15 @@
 /*
- * This keeps a list of Windows(R) types.
- *
  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
  *
  * Copyright (C) 1999
  *  David Corcoran <corcoran@linuxnet.com>
  *
- * $Id: wintypes.h,v 1.9 2004/07/06 17:05:04 rousseau Exp $
+ * $Id: wintypes.h,v 1.10 2005/04/12 12:09:18 rousseau Exp $
+ */
+
+/**
+ * @file
+ * @brief This keeps a list of Windows(R) types.
  */
 
 #ifndef __wintypes_h__