Dont want to do that again --- MySQL interface is now fully documented. Added little bit more documentation to the MSSQL interface.

1 files changed, 55 insertions, 0 deletions

diff --git a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLLogData.cs b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLLogData.cs
index c2f9653..3765ae1 100644
--- a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLLogData.cs
+++ b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLLogData.cs
@@ -1,13 +1,48 @@
+/*

+* Copyright (c) OpenSim project, http://sim.opensecondlife.org/

+*

+* Redistribution and use in source and binary forms, with or without

+* modification, are permitted provided that the following conditions are met:

+*     * Redistributions of source code must retain the above copyright

+*       notice, this list of conditions and the following disclaimer.

+*     * Redistributions in binary form must reproduce the above copyright

+*       notice, this list of conditions and the following disclaimer in the

+*       documentation and/or other materials provided with the distribution.

+*     * Neither the name of the <organization> nor the

+*       names of its contributors may be used to endorse or promote products

+*       derived from this software without specific prior written permission.

+*

+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY

+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

+* DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY

+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+* 

+*/

 using System;

 using System.Collections.Generic;

 using System.Text;

 

 namespace OpenGrid.Framework.Data.MySQL

 {

+    /// <summary>

+    /// An interface to the log database for MySQL

+    /// </summary>

     class MySQLLogData : ILogData

     {

+        /// <summary>

+        /// The database manager

+        /// </summary>

         public MySQLManager database;

 

+        /// <summary>

+        /// Artificial constructor called when the plugin is loaded

+        /// </summary>

         public void Initialise()

         {

             IniFile GridDataMySqlFile = new IniFile("mysql_connection.ini");

@@ -21,6 +56,15 @@ namespace OpenGrid.Framework.Data.MySQL
             database = new MySQLManager(settingHostname, settingDatabase, settingUsername, settingPassword, settingPooling, settingPort);

         }

 

+        /// <summary>

+        /// Saves a log item to the database

+        /// </summary>

+        /// <param name="serverDaemon">The daemon triggering the event</param>

+        /// <param name="target">The target of the action (region / agent UUID, etc)</param>

+        /// <param name="methodCall">The method call where the problem occured</param>

+        /// <param name="arguments">The arguments passed to the method</param>

+        /// <param name="priority">How critical is this?</param>

+        /// <param name="logMessage">The message to log</param>

         public void saveLog(string serverDaemon, string target, string methodCall, string arguments, int priority, string logMessage)

         {

             try

@@ -33,16 +77,27 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Returns the name of this DB provider

+        /// </summary>

+        /// <returns>A string containing the DB provider name</returns>

         public string getName()

         {

             return "MySQL Logdata Interface";

         }

 

+        /// <summary>

+        /// Closes the database provider

+        /// </summary>

         public void Close()

         {

             // Do nothing.

         }

 

+        /// <summary>

+        /// Returns the version of this DB provider

+        /// </summary>

+        /// <returns>A string containing the provider version</returns>

         public string getVersion()

         {

             return "0.1";