logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From grobme...@apache.org
Subject svn commit: r1531814 - in /logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j: ./ receivers/db/ receivers/net/ receivers/varia/ receivers/xml/
Date Mon, 14 Oct 2013 08:32:00 GMT
Author: grobmeier
Date: Mon Oct 14 08:31:59 2013
New Revision: 1531814

URL: http://svn.apache.org/r1531814
Log:
fixed javadocs

Modified:
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/DBAppender.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/CustomSQLDBReceiver.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DBReceiver.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DataSourceConnectionSource.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DriverManagerConnectionSource.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/JNDIConnectionSource.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/package.html
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/MulticastAppender.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketNodeEventListener.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketReceiver.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/UDPAppender.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/varia/LogFilePatternReceiver.java
    logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/xml/LogFileXMLReceiver.java

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/DBAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/DBAppender.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/DBAppender.java (original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/DBAppender.java Mon
Oct 14 08:31:59 2013
@@ -386,7 +386,7 @@ public class DBAppender extends Appender
   }
 
     /**
-     * @{inheritDoc}
+     * {@inheritDoc}
      */
   public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
{
         if ("connectionSource".equals(element.getNodeName())) {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/CustomSQLDBReceiver.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/CustomSQLDBReceiver.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/CustomSQLDBReceiver.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/CustomSQLDBReceiver.java
Mon Oct 14 08:31:59 2013
@@ -450,7 +450,7 @@ public class CustomSQLDBReceiver extends
     }
 
     /**
-     * @{inheritDoc}
+     * {@inheritDoc}
      */
   public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
{
         if ("connectionSource".equals(element.getNodeName())) {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DBReceiver.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DBReceiver.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DBReceiver.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DBReceiver.java
Mon Oct 14 08:31:59 2013
@@ -121,7 +121,7 @@ public class DBReceiver extends Receiver
   }
 
     /**
-     * @{inheritDoc}
+     * {@inheritDoc}
      */
   public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
{
         if ("connectionSource".equals(element.getNodeName())) {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DataSourceConnectionSource.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DataSourceConnectionSource.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DataSourceConnectionSource.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DataSourceConnectionSource.java
Mon Oct 14 08:31:59 2013
@@ -64,7 +64,7 @@ public class DataSourceConnectionSource 
   }
 
   /**
-   * @see org.apache.log4j.db.ConnectionSource#getConnection()
+   * @see org.apache.log4j.receivers.db.ConnectionSource#getConnection()
    */
   public Connection getConnection() throws SQLException {
     if (dataSource == null) {
@@ -88,7 +88,7 @@ public class DataSourceConnectionSource 
   }
 
     /**
-     * @{inheritDoc}
+     * {@inheritDoc}
      */
   public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
{
         if ("dataSource".equals(element.getNodeName())) {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DriverManagerConnectionSource.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DriverManagerConnectionSource.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DriverManagerConnectionSource.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/DriverManagerConnectionSource.java
Mon Oct 14 08:31:59 2013
@@ -85,7 +85,7 @@ public class DriverManagerConnectionSour
 
 
   /**
-   * @see org.apache.log4j.db.ConnectionSource#getConnection()
+   * @see org.apache.log4j.receivers.db.ConnectionSource#getConnection()
    */
   public Connection getConnection() throws SQLException {
     if (getUser() == null) {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/JNDIConnectionSource.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/JNDIConnectionSource.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/JNDIConnectionSource.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/JNDIConnectionSource.java
Mon Oct 14 08:31:59 2013
@@ -79,7 +79,7 @@ public class JNDIConnectionSource
   }
   
   /**
-   * @see org.apache.log4j.db.ConnectionSource#getConnection()
+   * @see org.apache.log4j.receivers.db.ConnectionSource#getConnection()
    */
   public Connection getConnection()
          throws SQLException {

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/package.html
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/package.html?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/package.html
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/db/package.html
Mon Oct 14 08:31:59 2013
@@ -20,7 +20,7 @@
 
 <p>The org.apache.log4j.db package provides means to append logging events 
 into various databases. The persisted data can be later read back using
-{@link org.apache.log4j.db.DBReceiver}.
+{@link org.apache.log4j.receivers.db.DBReceiver}.
 </p>
 
 <p>Most popular database systems, such as PostgreSQL, MySQL, Oracle, DB2 and MsSQL
@@ -28,7 +28,7 @@ are supported.
 </p>
 
 <p>Just as importantly, the way for obtaining JDBC connections is pluggable. Connections
can
-be obtained through the tradinal way of DriverManager, or alternatively as a DataSource.

+be obtained through the traditional way of DriverManager, or alternatively as a DataSource.
 A DataSource can be instantiated directly or it can obtained through JNDI.
 </p>
 

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/MulticastAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/MulticastAppender.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/MulticastAppender.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/MulticastAppender.java
Mon Oct 14 08:31:59 2013
@@ -47,7 +47,7 @@ import java.util.Map;
  *  By setting the remoteHost to a broadcast address any number of clients can
  *  listen for log messages.
  *
- *  <p>This was inspired and really extended/copied from {@link SocketAppender}.  Please
+ *  <p>This was inspired and really extended/copied from {@link org.apache.log4j.net.SocketAppender}.
 Please
  *  see the docs for the proper credit to the authors of that class.
  *
  *  @author  <a href="mailto:kbrown@versatilesolutions.com">Kevin Brown</a>

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketNodeEventListener.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketNodeEventListener.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketNodeEventListener.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketNodeEventListener.java
Mon Oct 14 08:31:59 2013
@@ -20,7 +20,7 @@ package org.apache.log4j.receivers.net;
 import java.util.EventListener;
 
 /**
-  Interface used to listen for {@link SocketNode} related
+  Interface used to listen for {@link org.apache.log4j.net.SocketNode} related
   events. Clients register an instance of the interface and the
   instance is called back when the various events occur.
 

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketReceiver.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketReceiver.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketReceiver.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/SocketReceiver.java
Mon Oct 14 08:31:59 2013
@@ -114,12 +114,10 @@ public class SocketReceiver extends Rece
     repository = repo;
   }
 
-    /** {@inheritDoc} */
   public int getPort() {
     return port;
   }
 
-  /** {@inheritDoc} */
   public void setPort(final int p) {
     port = p;
   }

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/UDPAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/UDPAppender.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/UDPAppender.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/net/UDPAppender.java
Mon Oct 14 08:31:59 2013
@@ -46,7 +46,7 @@ import java.net.UnknownHostException;
  *  By setting the remoteHost to a broadcast address any number of clients can
  *  listen for log messages.
  *
- *  <p>This was inspired and really extended/copied from {@link SocketAppender}.
+ *  <p>This was inspired and really extended/copied from {@link org.apache.log4j.net.SocketAppender}.
  *  Please see the docs for the proper credit to the authors of that class.
  *
  *  @author  <a href="mailto:kbrown@versatilesolutions.com">Kevin Brown</a>

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/varia/LogFilePatternReceiver.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/varia/LogFilePatternReceiver.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/varia/LogFilePatternReceiver.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/varia/LogFilePatternReceiver.java
Mon Oct 14 08:31:59 2013
@@ -292,7 +292,7 @@ public class LogFilePatternReceiver exte
    * When true, this property uses the current Thread to perform the import,
    * otherwise when false (the default), a new Thread is created and started to manage
    * the import.
-   * @return
+   * @return true, if the current thread is used
    */ 
  public final boolean isUseCurrentThread() {
      return useCurrentThread;

Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/xml/LogFileXMLReceiver.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/xml/LogFileXMLReceiver.java?rev=1531814&r1=1531813&r2=1531814&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/xml/LogFileXMLReceiver.java
(original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/receivers/xml/LogFileXMLReceiver.java
Mon Oct 14 08:31:59 2013
@@ -91,7 +91,7 @@ public class LogFileXMLReceiver extends 
     /**
      * Accessor
      * 
-     * @return
+     * @return the decoder
      */
     public String getDecoder() {
         return decoder;
@@ -287,7 +287,7 @@ public class LogFileXMLReceiver extends 
      * When true, this property uses the current Thread to perform the import, otherwise
when false
      * (the default), a new Thread is created and started to manage the import.
      * 
-     * @return
+     * @return true, if the current thread is used
      */
     public final boolean isUseCurrentThread() {
         return useCurrentThread;



Mime
View raw message