Changeset 3057 for trunk/sources/HeuristicLab.Tracing/3.2

Timestamp:

03/16/10 10:21:41 (15 years ago)

Author:

epitzer

Message:

Fix warnings (#915)

File:

• trunk/sources/HeuristicLab.Tracing/3.2/Logger.cs (modified) (13 diffs)

trunk/sources/HeuristicLab.Tracing/3.2/Logger.cs

@@ -29 +29 @@
 namespace HeuristicLab.Tracing {
 
+  /// <summary>
+  /// HeuristicLab Tracing entry point. Default logger. Reads configured tracing
+  /// file and provides automatic logging with reflection of the calling type.
+  /// </summary>
   public class Logger {
 
+    /// <summary>
+    /// true if Configure has been called already.
+    /// </summary>
     protected static bool IsConfigured = false;
 
+    /// <summary>
+    /// Configures this instance: Reads the log file specified in the settings.
+    /// </summary>
     protected static void Configure() {
       if (IsConfigured) return;
@@ -45 +55 @@
     }
 
+    /// <summary>
+    /// Gets the default logger for the calling class n levels up in the
+    /// call hierarchy.
+    /// </summary>
+    /// <param name="nParents">The number of parent calls.</param>
+    /// <returns>An <see cref="ILog"/> instance.</returns>
     public static ILog GetDefaultLogger(int nParents) {
       Configure();
@@ -51 +67 @@
     }
 
+    /// <summary>
+    /// Gets the default logger: The logger for the class of the
+    /// calling method.
+    /// </summary>
+    /// <returns>An <see cref="ILog"/> instance.</returns>
     public static ILog GetDefaultLogger() {
       Configure();
@@ -57 +78 @@
     }
 
+    /// <summary>
+    /// Issues a debug message to the default logger.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public static void Debug(object message) {
       GetDefaultLogger(1).Debug(message);
     }
 
+    /// <summary>
+    /// Issues an informational message to the default logger.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public static void Info(object message) {
       GetDefaultLogger(1).Info(message);
     }
 
+    /// <summary>
+    /// Issues a warning message to the default logger.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public static void Warn(object message) {
       GetDefaultLogger(1).Warn(message);
     }
 
+    /// <summary>
+    /// Issues an error message to the default logger.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public static void Error(object message) {
       GetDefaultLogger(1).Error(message);
     }
 
+    /// <summary>
+    /// Issues a fatal error message to the default logger.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public static void Fatal(object message) {
       GetDefaultLogger(1).Fatal(message);
     }
 
+    /// <summary>
+    /// Issues a debug message to the logger of the specified type.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
     public static void Debug(Type type, object message) {
       Configure();
@@ -82 +128 @@
     }
 
+    /// <summary>
+    /// Issues an iformational message to the logger of the specified
+    /// type.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
     public static void Info(Type type, object message) {
       Configure();
@@ -87 +139 @@
     }
 
+    /// <summary>
+    /// Issues a warning message to the logger of
+    /// the specified type.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
     public static void Warn(Type type, object message) {
       Configure();
@@ -92 +150 @@
     }
 
+    /// <summary>
+    /// Issues an error message to the logger of the specified
+    /// type.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
     public static void Error(Type type, object message) {
       Configure();
@@ -97 +161 @@
     }
 
+    /// <summary>
+    /// Issues a fatal error message to the logger of
+    /// the specified type.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
     public static void Fatal(Type type, object message) {
       Configure();
@@ -102 +172 @@
     }
 
+    /// <summary>
+    /// Issues a debug message to the default
+    /// logger including an exception.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Debug(object message, Exception exception) {
       GetDefaultLogger(1).Debug(message, exception);
     }
 
+    /// <summary>
+    /// Issues an informational message to the default
+    /// logger including an exception.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
+
     public static void Info(object message, Exception exception) {
       GetDefaultLogger(1).Info(message, exception);
     }
 
+    /// <summary>
+    /// Issues a warning message to the default
+    /// logger including an exception.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Warn(object message, Exception exception) {
       GetDefaultLogger(1).Warn(message, exception);
     }
 
+    /// <summary>
+    /// Issues an error message to the default
+    /// logger including an exception.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Error(object message, Exception exception) {
       GetDefaultLogger(1).Error(message, exception);
     }
 
+    /// <summary>
+    /// Issues a fatal error message to the default
+    /// logger including an exception.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Fatal(object message, Exception exception) {
       GetDefaultLogger(1).Fatal(message, exception);
     }
 
+    /// <summary>
+    /// Issues a debug message to the logger of the specified
+    /// type including an exception.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Debug(Type type, object message, Exception exception) {
       Configure();
@@ -127 +235 @@
     }
 
+    /// <summary>
+    /// Issues an informational message to the logger of the specified
+    /// type including an exception.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Info(Type type, object message, Exception exception) {
       Configure();
@@ -132 +247 @@
     }
 
+    /// <summary>
+    /// Issues a warning message to the logger of the specified
+    /// type including an exception.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Warn(Type type, object message, Exception exception) {
       Configure();
@@ -137 +259 @@
     }
 
+    /// <summary>
+    /// Issues an error message to the logger of the specified
+    /// type including an exception.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Error(Type type, object message, Exception exception) {
       Configure();
@@ -142 +271 @@
     }
 
+    /// <summary>
+    /// Issues a fatal error message to the logger of the specified
+    /// type including an exception.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="exception">The exception.</param>
     public static void Fatal(Type type, object message, Exception exception) {
       Configure();
       LogManager.GetLogger(type).Fatal(message, exception);
     }
-
   }
 }