[slf4j-dev] svn commit: r161 - in slf4j/trunk/src: filtered-java/org/slf4j java/org/slf4j

[ceki at slf4j.org]

Author: ceki
Date: Sat Aug 13 14:44:50 2005
New Revision: 161

Modified:
   slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java
   slf4j/trunk/src/filtered-java/org/slf4j/MarkerFactory.java
   slf4j/trunk/src/java/org/slf4j/ILoggerFactory.java
   slf4j/trunk/src/java/org/slf4j/IMarkerFactory.java
Log:
- improved javadocs
- added getIMarkerFactory method to Markerfactory

Modified: slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java
==============================================================================
--- slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java	(original)
+++ slf4j/trunk/src/filtered-java/org/slf4j/LoggerFactory.java	Sat Aug 13 14:44:50 2005
@@ -49,7 +49,7 @@
  * <p>Please note that all methods in <code>LoggerFactory</code> are 
  * static.
  * 
- * @author Ceki G&uuml;lc&uuml;
+ * @author <a href="http://www.qos.ch/log4j/">Ceki G&uuml;lc&uuml;</a>
  */
 public final class LoggerFactory {
   static ILoggerFactory loggerFactory;
@@ -144,4 +144,17 @@
   public static Logger getLogger(Class clazz) {
     return loggerFactory.getLogger(clazz.getName());
   }
+  
+  /**
+   * Return the {@link ILoggerFactory} instance in use.
+   * 
+   * <p>Usually, the ILoggerFactory instance is bound with this class 
+   * at compile time.
+   * 
+   * @return the ILoggerFactory instance in use
+   */
+  public static ILoggerFactory getILoggerFactory() {
+    return loggerFactory;
+  }
+  
 }

Modified: slf4j/trunk/src/filtered-java/org/slf4j/MarkerFactory.java
==============================================================================
--- slf4j/trunk/src/filtered-java/org/slf4j/MarkerFactory.java	(original)
+++ slf4j/trunk/src/filtered-java/org/slf4j/MarkerFactory.java	Sat Aug 13 14:44:50 2005
@@ -38,15 +38,15 @@
 
 
 /**
- * MarkerFactory is a utility class producing Marker instances as appropriate 
- * for each logging systems.
+ * MarkerFactory is a utility class producing {@link Marker} instances as appropriate
+ * for the logging system currently in use.
  * 
- * MarkerFactory is essentially a wrapper around an IMarkerFactory instance 
- * bound with the MarkerFactory class at compile time. 
+ * <p>This class is essentially implemented as a wrapper around an {@link IMarkerFactory}
+ * instance bound at compile time.
  * 
- * Please note that all methods in MarkerFactory are static.
+ * <p>Please note that all methods in this class are static.
  * 
- * @author Ceki Gulcu
+ * @author <a href="http://www.qos.ch/log4j/">Ceki G&uuml;lc&uuml;</a>
  */
 public class MarkerFactory {
   static IMarkerFactory markerFactory;
@@ -71,13 +71,27 @@
   }
   
   /**
-   * Return a Marker instnace as specified by the name parameter using the 
-   * previously bound  {@link IMarkerFactory} instance.
+   * Return a Marker instnace as specified by the name parameter using the
+   * previously bound {@link IMarkerFactory}instance.
    * 
-   * @param name The name of the {@link Marker} object to return. 
+   * @param name
+   *            The name of the {@link Marker}object to return.
    * @return marker
    */
   public static Marker getMarker(String name) {
     return markerFactory.getMarker(name);
   }
+  
+  /**
+   * Return the {@link IMarkerFactory} instance in use.
+   * 
+   * <p>
+   * Usually, the IMarkerFactory instance is bound with this class
+   * at compile time.
+   * 
+   * @return the IMarkerFactory instance in use
+   */
+  public static IMarkerFactory getIMarkerFactory() {
+    return  markerFactory;
+  }
 }

Modified: slf4j/trunk/src/java/org/slf4j/ILoggerFactory.java
==============================================================================
--- slf4j/trunk/src/java/org/slf4j/ILoggerFactory.java	(original)
+++ slf4j/trunk/src/java/org/slf4j/ILoggerFactory.java	Sat Aug 13 14:44:50 2005
@@ -39,12 +39,15 @@
  * 
  * <p>Most users retreive {@link Logger} instances through the static
  * {@link LoggerFactory#getLogger} mehtod. An instance of of this
- * interface is bound internally with {@link LoggerFactory} compile
- * time. Only developers of SLF4J conformant logging systems SLF4J
+ * interface is bound internally with {@link LoggerFactory} class at 
+ * compile time. Only developers of SLF4J conformant logging systems 
  * need to worry about this interface. 
  * 
+ * <p>See the section <a href="http://slf4j.org/faq.html#3">Implementing 
+ * the SLF4J API</a> in the FAQ for details on how to make your logging 
+ * system conform to SLF4J.
+ * 
  * @author <a href="http://www.qos.ch/log4j/">Ceki G&uuml;lc&uuml;</a>
- *
  */
 public interface ILoggerFactory {
   

Modified: slf4j/trunk/src/java/org/slf4j/IMarkerFactory.java
==============================================================================
--- slf4j/trunk/src/java/org/slf4j/IMarkerFactory.java	(original)
+++ slf4j/trunk/src/java/org/slf4j/IMarkerFactory.java	Sat Aug 13 14:44:50 2005
@@ -36,7 +36,11 @@
 /**
  * Implementaitons of this interface are used to manufacture {@link Marker}
  * instances.
- *
+ * 
+ * <p>See the section <a href="http://slf4j.org/faq.html#3">Implementing 
+ * the SLF4J API</a> in the FAQ for details on how to make your logging 
+ * system conform to SLF4J.
+ * 
  * @author <a href="http://www.qos.ch/log4j/">Ceki G&uuml;lc&uuml;</a>
  */
 public interface IMarkerFactory {