You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by ca...@apache.org on 2006/01/28 00:19:06 UTC

svn commit: r373024 - in /logging/log4j/trunk: ./ docs/ src/java/org/apache/log4j/ src/java/org/apache/log4j/filter/ src/java/org/apache/log4j/helpers/ src/java/org/apache/log4j/net/ src/java/org/apache/log4j/selector/ src/java/org/apache/log4j/varia/ ...

Author: carnold
Date: Fri Jan 27 15:18:59 2006
New Revision: 373024

URL: http://svn.apache.org/viewcvs?rev=373024&view=rev
Log:
Bug 36332, 38428: Bad J2SE doc link, javadoc sentence breaks, copyright and licence updates

Added:
    logging/log4j/trunk/docs/overview.html
Modified:
    logging/log4j/trunk/build.xml
    logging/log4j/trunk/docs/   (props changed)
    logging/log4j/trunk/docs/manual.html
    logging/log4j/trunk/src/java/org/apache/log4j/FileAppender.java
    logging/log4j/trunk/src/java/org/apache/log4j/filter/StringMatchFilter.java
    logging/log4j/trunk/src/java/org/apache/log4j/helpers/BoundedFIFO.java
    logging/log4j/trunk/src/java/org/apache/log4j/net/UDPAppender.java
    logging/log4j/trunk/src/java/org/apache/log4j/selector/ContextJNDISelector.java
    logging/log4j/trunk/src/java/org/apache/log4j/selector/package.html
    logging/log4j/trunk/src/java/org/apache/log4j/varia/LogFilePatternReceiver.java
    logging/log4j/trunk/src/xdocs/stylesheets/site.vsl

Modified: logging/log4j/trunk/build.xml
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/build.xml?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/build.xml (original)
+++ logging/log4j/trunk/build.xml Fri Jan 27 15:18:59 2006
@@ -830,7 +830,7 @@
     
     <mkdir dir="${javadoc.dest}" />
     <mkdir dir="${javadoc.api.dest}" />
-    
+    <copy file="docs/overview.html" todir="${javadoc.dest}"/>
     <javadoc
              destdir="${javadoc.api.dest}"
              packagenames="org.apache.log4j,
@@ -859,7 +859,6 @@
                  org.apache.joran.action,
                  org.apache.log4j.joran,
                  org.apache.log4j.joran.action"
-             additionalparam="-breakiterator"
              version="true"
              protected="true"
              author="true"
@@ -868,12 +867,13 @@
              doctitle="log4j version ${version}&lt;br&gt;API Specification"
              windowtitle="Log4j Version ${version}"
              header="&lt;b&gt;Log4j ${version}&lt;/b&gt;"
-             bottom="Copyright 2000-2006 Apache Software Foundation.">
+             bottom='Copyright &#169; 2000-2006 Apache Software Foundation. &lt;br /&gt;
+Licensed under the &lt;a href="http://www.apache.org/licenses/LICENSE-2.0"&gt;Apache License, Version 2.0&lt;/a&gt;.'>
       <sourcepath>
          <pathelement path="${java.source.dir}"/>
       </sourcepath>
       
-      <link href="http://java.sun.com/products/j2se/1.3/docs/api/"/>
+      <link href="http://java.sun.com/j2se/1.3/docs/api/"/>
       <link href="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
       <classpath refid="compile.classpath"/>
       <classpath path="${regexp.oro.jar}"/>

Propchange: logging/log4j/trunk/docs/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Fri Jan 27 15:18:59 2006
@@ -3,6 +3,7 @@
 contactUs.html
 index-files
 org
+codes.html
 contributors.html
 plan.html
 download.html
@@ -14,3 +15,6 @@
 chainsaw.html
 install-chainsaw.html
 faq.html
+ugli.html
+
+

Modified: logging/log4j/trunk/docs/manual.html
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/docs/manual.html?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/docs/manual.html (original)
+++ logging/log4j/trunk/docs/manual.html Fri Jan 27 15:18:59 2006
@@ -15,13 +15,10 @@
 </center>
 
 <p>
-      Copyright &copy; 2000-2004 The Apache Software Foundation. All
-      rights reserved.  This software is published under the terms of
-      the Apache Software License version 1.1, a copy of which has
-      been included in the LICENSE.txt file shipped with the log4j
-      distribution. The present short manual also borrows some text
-      from <a
-      href="https://www.qos.ch/shop/products/log4j/log4j-Manual.jsp">"<em>The
+    Copyright &#169; 2000-2006, The Apache Software Foundation.  
+    Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+    The present short manual also borrows some text from 
+    <a href="https://www.qos.ch/shop/products/log4j/log4j-Manual.jsp">"<em>The
       complete log4j manual</em>"</a>, which contains more detailed
       and up to date information, by the same author (yours truly).
 </p>

Added: logging/log4j/trunk/docs/overview.html
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/docs/overview.html?rev=373024&view=auto
==============================================================================
--- logging/log4j/trunk/docs/overview.html (added)
+++ logging/log4j/trunk/docs/overview.html Fri Jan 27 15:18:59 2006
@@ -0,0 +1,12 @@
+<html>
+<head>
+
+<title>Short log4j introduction</title>
+</head>
+<body>
+The reliable, fast and flexible logging framework for Java.
+
+<p>Make sure to read the <a href="../manual.html"><b>user manual</b></a>
+in addition to this javadoc documentation.
+
+</body> </html>

Modified: logging/log4j/trunk/src/java/org/apache/log4j/FileAppender.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/FileAppender.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/FileAppender.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/FileAppender.java Fri Jan 27 15:18:59 2006
@@ -40,7 +40,8 @@
  * */
 public class FileAppender extends WriterAppender {
   /** 
-   * Append to or truncate the file? The default value for this variable is 
+   * Controls whether to append to or truncate an existing file. 
+   * The default value for this variable is 
    * <code>true</code>, meaning that by default a <code>FileAppender</code> will
    *  append to an existing file and not truncate it. 
    * 

Modified: logging/log4j/trunk/src/java/org/apache/log4j/filter/StringMatchFilter.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/filter/StringMatchFilter.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/filter/StringMatchFilter.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/filter/StringMatchFilter.java Fri Jan 27 15:18:59 2006
@@ -20,7 +20,7 @@
 import org.apache.log4j.spi.LoggingEvent;
 
 /**
-   This is a very simple filter based on string matching.<br/>
+   This is a very simple filter based on string matching.
 
    <p>The filter admits two options <b>StringToMatch</b> and
    <b>AcceptOnMatch</b>. If there is a match between the value of the

Modified: logging/log4j/trunk/src/java/org/apache/log4j/helpers/BoundedFIFO.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/helpers/BoundedFIFO.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/helpers/BoundedFIFO.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/helpers/BoundedFIFO.java Fri Jan 27 15:18:59 2006
@@ -90,7 +90,7 @@
   }
 
   /**
-     Return <code>true</code> if the buffer is full, i.e. of the
+     Return <code>true</code> if the buffer is full, that is the
      number of elements in the buffer equals the buffer size. */
   public 
   boolean isFull() {

Modified: logging/log4j/trunk/src/java/org/apache/log4j/net/UDPAppender.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/net/UDPAppender.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/net/UDPAppender.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/net/UDPAppender.java Fri Jan 27 15:18:59 2006
@@ -48,7 +48,7 @@
  */
 public class UDPAppender extends AppenderSkeleton implements PortBased{
   /**
-     The default port number for the UDP packets. (9991).
+    * The default port number for the UDP packets, 9991.
   */
   public static final int DEFAULT_PORT = 9991;
 

Modified: logging/log4j/trunk/src/java/org/apache/log4j/selector/ContextJNDISelector.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/selector/ContextJNDISelector.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/selector/ContextJNDISelector.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/selector/ContextJNDISelector.java Fri Jan 27 15:18:59 2006
@@ -37,9 +37,9 @@
 
 
 /**
- * Log4j JNDI based Repository selector
+ * Defines a unique logger repository for each web-application in a J2EE environment.
  *
- * <p>based primarily on Ceki G&uuml;lc&uuml;'s article <h3>Supporting the Log4j
+ * This implementation is <p>based primarily on Ceki G&uuml;lc&uuml;'s article <h3>Supporting the Log4j
  * <code>RepositorySelector</code> in Servlet Containers</h3> at:
  * http://qos.ch/logging/sc.html</p>
  *

Modified: logging/log4j/trunk/src/java/org/apache/log4j/selector/package.html
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/selector/package.html?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/selector/package.html (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/selector/package.html Fri Jan 27 15:18:59 2006
@@ -7,10 +7,10 @@
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </head>
 <body>
-  <h1>org.apache.log4j.selector</h1>
-  <p>This package contains classes useful for working with Log4j in a container
+    This package contains classes useful for working with Log4j in a container
     environment where many applications need to share Log4j without stepping
-    on each other's logging configuration.  Each of these classes implements
+    on each other's logging configuration.
+  <p>Each of these classes implements
     the <code>RepositorySelector</code> interface.  Only one class may be used
     per instance of Log4j.  The container normally sets the repository selector,
     but one may assign the selector themselves using the InitContextListener in

Modified: logging/log4j/trunk/src/java/org/apache/log4j/varia/LogFilePatternReceiver.java
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/java/org/apache/log4j/varia/LogFilePatternReceiver.java?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/java/org/apache/log4j/varia/LogFilePatternReceiver.java (original)
+++ logging/log4j/trunk/src/java/org/apache/log4j/varia/LogFilePatternReceiver.java Fri Jan 27 15:18:59 2006
@@ -407,8 +407,8 @@
   }
 
   /**
-   * Read, parse and optionally tail the log file, converting entries into logging events
-   * <p>
+   * Read, parse and optionally tail the log file, converting entries into logging events.
+   * 
    * A runtimeException is thrown if the logFormat pattern is malformed 
    * according to ORO's Perl5Compiler.
    * 

Modified: logging/log4j/trunk/src/xdocs/stylesheets/site.vsl
URL: http://svn.apache.org/viewcvs/logging/log4j/trunk/src/xdocs/stylesheets/site.vsl?rev=373024&r1=373023&r2=373024&view=diff
==============================================================================
--- logging/log4j/trunk/src/xdocs/stylesheets/site.vsl (original)
+++ logging/log4j/trunk/src/xdocs/stylesheets/site.vsl Fri Jan 27 15:18:59 2006
@@ -299,7 +299,8 @@
              
                 <!-- FOOTER -->
               <div align="center"><font color="$bodylink" size="-1"><em>
-                 Copyright &#169; 1999-2006, Apache Software Foundation
+                 Copyright &#169; 1999-2006, Apache Software Foundation.<br />
+Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
                </em></font></div>
 
            <!-- END main table --> 



---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org