From a7fe1b63f31fdfe438ed52512ccd277f9e33ff2e Mon Sep 17 00:00:00 2001
From: Adam Frisby
Date: Fri, 1 Jun 2007 23:34:37 +0000
Subject: * ZOMG Wtf Comments? * OpenGrid.Framework.Data is now well documented

---
 .../OpenGrid.Framework.Data/ILogData.cs            | 51 ++++++++++++++++++++++
 1 file changed, 51 insertions(+)

(limited to 'OpenGridServices/OpenGrid.Framework.Data/ILogData.cs')

diff --git a/OpenGridServices/OpenGrid.Framework.Data/ILogData.cs b/OpenGridServices/OpenGrid.Framework.Data/ILogData.cs
index 7c6a2c5..53d0204 100644
--- a/OpenGridServices/OpenGrid.Framework.Data/ILogData.cs
+++ b/OpenGridServices/OpenGrid.Framework.Data/ILogData.cs
@@ -1,18 +1,69 @@
+/*
+* 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
 {
+    /// <summary>
+    /// The severity of an individual log message
+    /// </summary>
     public enum LogSeverity : int
     {
+        /// <summary>
+        /// Critical: systems failure
+        /// </summary>
         CRITICAL = 1,
+        /// <summary>
+        /// Major: warning prior to systems failure
+        /// </summary>
         MAJOR = 2,
+        /// <summary>
+        /// Medium: an individual non-critical task failed
+        /// </summary>
         MEDIUM = 3,
+        /// <summary>
+        /// Low: Informational warning
+        /// </summary>
         LOW = 4,
+        /// <summary>
+        /// Info: Information
+        /// </summary>
         INFO = 5,
+        /// <summary>
+        /// Verbose: Debug Information
+        /// </summary>
         VERBOSE = 6
     }
+
+    /// <summary>
+    /// An interface to a LogData storage system
+    /// </summary>
     public interface ILogData
     {
         void saveLog(string serverDaemon, string target, string methodCall, string arguments, int priority,string logMessage);
-- 
cgit v1.1