From d96caaa14e9e869e85eecc6b760221ad0579f68e Mon Sep 17 00:00:00 2001
From: Jeff Ames
Date: Thu, 26 Jun 2008 20:20:30 +0000
Subject: Apply patch from bug #1606 -- Documentation for Data/Null, Data/Base.
  Thanks kerunix_Flan!

---
 OpenSim/Data/Base/BaseDatabaseConnector.cs | 43 ++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

(limited to 'OpenSim/Data/Base/BaseDatabaseConnector.cs')

diff --git a/OpenSim/Data/Base/BaseDatabaseConnector.cs b/OpenSim/Data/Base/BaseDatabaseConnector.cs
index 6988839..542004c 100644
--- a/OpenSim/Data/Base/BaseDatabaseConnector.cs
+++ b/OpenSim/Data/Base/BaseDatabaseConnector.cs
@@ -32,10 +32,17 @@ using System.Data.Common;
 
 namespace OpenSim.Data.Base
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public abstract class BaseDatabaseConnector
     {
         protected string m_connectionString;
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="connectionString"></param>
         public BaseDatabaseConnector(string connectionString)
         {
             m_connectionString = connectionString;
@@ -44,6 +51,14 @@ namespace OpenSim.Data.Base
         public abstract DbConnection GetNewConnection();
         public abstract string CreateParamName(string fieldName);
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="mapper"></param>
+        /// <param name="connection"></param>
+        /// <param name="fieldName"></param>
+        /// <param name="key"></param>
+        /// <returns></returns>
         public DbCommand CreateSelectCommand(BaseTableMapper mapper, DbConnection connection, string fieldName, object key)
         {
             string table = mapper.TableName;
@@ -61,6 +76,14 @@ namespace OpenSim.Data.Base
             return command;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="mapper"></param>
+        /// <param name="command"></param>
+        /// <param name="fieldName"></param>
+        /// <param name="key"></param>
+        /// <returns></returns>
         public string CreateCondition(BaseTableMapper mapper, DbCommand command, string fieldName, object key)
         {
             string keyFieldParamName = mapper.CreateParamName(fieldName);
@@ -73,6 +96,14 @@ namespace OpenSim.Data.Base
             return String.Format("{0}={1}", fieldName, keyFieldParamName);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="mapper"></param>
+        /// <param name="connection"></param>
+        /// <param name="rowMapper"></param>
+        /// <param name="primaryKey"></param>
+        /// <returns></returns>
         public DbCommand CreateUpdateCommand(BaseTableMapper mapper, DbConnection connection, object rowMapper, object primaryKey)
         {
             string table = mapper.TableName;
@@ -105,6 +136,13 @@ namespace OpenSim.Data.Base
             return command;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="mapper"></param>
+        /// <param name="connection"></param>
+        /// <param name="obj"></param>
+        /// <returns></returns>
         public DbCommand CreateInsertCommand(BaseTableMapper mapper, DbConnection connection, object obj)
         {
             string table = mapper.TableName;
@@ -132,6 +170,11 @@ namespace OpenSim.Data.Base
             return command;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
         public virtual object ConvertToDbType(object value)
         {
             return value;
-- 
cgit v1.1