Connector/ODBC 3.51 commit: r329 - trunk/driver

[jwinstead]

Modified:
   trunk/driver/catalog.c
   trunk/driver/connect.c
   trunk/driver/cursor.c
   trunk/driver/dll.c
   trunk/driver/error.c
   trunk/driver/execute.c
   trunk/driver/handle.c
   trunk/driver/info.c
   trunk/driver/myodbc3.c
   trunk/driver/options.c
   trunk/driver/prepare.c
   trunk/driver/results.c
   trunk/driver/transact.c
Log:
Add (or fix) descriptions of each file.


Modified: trunk/driver/catalog.c
===================================================================
--- trunk/driver/catalog.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/catalog.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -21,7 +21,8 @@
 */
 
 /**
-  Catalog functions.
+  @file  catalog.c
+  @brief Catalog functions.
 */
 
 /***************************************************************************

Modified: trunk/driver/connect.c
===================================================================
--- trunk/driver/connect.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/connect.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * CONNECT.C								   *
- *									   *
- * @description: This is the MyODBC 3.51 sample driver code for connection *
- *									   *
- * @author     : MySQL AB (monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  connect.c
+  @brief Connection functions.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/cursor.c
===================================================================
--- trunk/driver/cursor.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/cursor.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,19 +20,12 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
+/**
+  @file  cursor.c
+  @brief Client-side cursor functions
+*/
 
 /***************************************************************************
- * CURSOR.C								   *
- *									   *
- * @description: Client side cursor functionality handling		   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
-
-/***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *
  *									   *
  *   SQLSetCursorName	 (ISO 92)					   *

Modified: trunk/driver/dll.c
===================================================================
--- trunk/driver/dll.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/dll.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * DLL.C								   *
- *									   *
- *  @description: For LIBMAIN processing				   *
- *									   *
- *  @author	: MySQL AB(monty@stripped, venu@stripped)		   *
- *  @date	: 2001-Aug-15						   *
- *  @product	: myodbc3						   *
- *									   *
-****************************************************************************/
+/**
+  @file  dll.c
+  @brief Library initialization functions.
+*/
 
 #include "myodbc3.h"
 #include <locale.h>

Modified: trunk/driver/error.c
===================================================================
--- trunk/driver/error.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/error.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * ERROR.C								   *
- *									   *
- * @description: MyODBC 3.51 error handling				   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  error.c
+  @brief Error handling functions.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/execute.c
===================================================================
--- trunk/driver/execute.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/execute.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * EXECUTE.C								   *
- *									   *
- * @description: Driver code for executing SQL Commands			   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  execute.c
+  @brief Statement execution functions.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/handle.c
===================================================================
--- trunk/driver/handle.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/handle.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * HANDLE.C								   *
- *									   *
- * @description: Allocation and freeing of handles			   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Nov-07						   *
- * @product    : myodbc3						   *
- *									   *
-****************************************************************************/
+/**
+  @file  handle.c
+  @brief Allocation and freeing of handles.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/info.c
===================================================================
--- trunk/driver/info.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/info.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,6 +20,11 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
+/**
+  @file  info.c
+  @brief Driver information functions.
+*/
+
 #include "myodbc3.h"
 
 char allowed_chars[]=

Modified: trunk/driver/myodbc3.c
===================================================================
--- trunk/driver/myodbc3.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/myodbc3.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,15 +20,9 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * MYODBC3.C								   *
- *									   *
- * @description: Code for generating precompiled headers		   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
-****************************************************************************/
+/**
+  @file  myodbc3.c
+  @brief Stub for forcing creation of precompiled headers.
+*/
 
 #include "myodbc3.h"

Modified: trunk/driver/options.c
===================================================================
--- trunk/driver/options.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/options.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * OPTIONS.C								   *
- *									   *
- * @description: For handling attribute APIs				   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  options.c
+  @brief Functions for handling handle attributes and options.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/prepare.c
===================================================================
--- trunk/driver/prepare.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/prepare.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * PREPARE.C								   *
- *									   *
- * @description: For handling prepare statements			   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  prepare.c
+  @brief Prepared statement functions.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/results.c
===================================================================
--- trunk/driver/results.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/results.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -20,16 +20,10 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
-/***************************************************************************
- * RESULTS.C								   *
- *									   *
- * @description: For handling resultset and resultset information	   *
- *									   *
- * @author     : MySQL AB(monty@stripped, venu@stripped)		   *
- * @date       : 2001-Aug-15						   *
- * @product    : myodbc3						   *
- *									   *
- ****************************************************************************/
+/**
+  @file  results.c
+  @brief Result set and related information functions.
+*/
 
 /***************************************************************************
  * The following ODBC APIs are implemented in this file:		   *

Modified: trunk/driver/transact.c
===================================================================
--- trunk/driver/transact.c	2007-04-26 19:48:18 UTC (rev 328)
+++ trunk/driver/transact.c	2007-04-26 20:55:46 UTC (rev 329)
@@ -21,7 +21,8 @@
 */
 
 /**
-  Transaction processing functions.
+  @file  transact.c
+  @brief Transaction processing functions.
 */
 
 #include "myodbc3.h"