Attached is a doc patch for avalon-logkit.
The patch to build.xml includes links to external JavaDocs, and fixes
deprecated ant tags (use file instead of jarfile).
-Mark
Index: build.xml
===================================================================
RCS file: /home/cvspublic/jakarta-avalon-logkit/build.xml,v
retrieving revision 1.68
diff -u -r1.68 build.xml
--- build.xml 31 Jan 2002 16:27:41 -0000 1.68
+++ build.xml 9 Feb 2002 01:22:19 -0000
@@ -341,7 +341,7 @@
<mkdir dir="${build.lib}"/>
- <jar jarfile="${build.lib}/${name}.jar" basedir="${build.classes}"
compress="${compress.jars}">
+ <jar file="${build.lib}/${name}.jar" basedir="${build.classes}"
+compress="${compress.jars}">
<include name="org/apache/log/**" />
<exclude name="**/test/*" />
</jar>
@@ -392,12 +392,15 @@
destdir="${build.javadocs}">
<classpath refid="project.class.path" />
<doclet name="com.sun.tools.doclets.standard.Standard">
- <param name="-author"/>
- <param name="-version"/>
- <param name="-doctitle" value="${Name}"/>
- <param name="-windowtitle" value="${Name} API"/>
- <param name="-bottom"
- value=""Copyright © 2001 Apache Jakarta Project. All Rights
Reserved.""/>
+ <param name="-author"/>
+ <param name="-version"/>
+ <param name="-doctitle" value="${Name}"/>
+ <param name="-windowtitle" value="${Name} API"/>
+ <param name="-bottom"
+ value=""Copyright © 2001 Apache Jakarta Project. All Rights
+Reserved.""/>
+ <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
+ <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
+ <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
</doclet>
</javadoc>
Index: src/java/org/apache/log/format/PatternFormatter.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-logkit/src/java/org/apache/log/format/PatternFormatter.java,v
retrieving revision 1.24
diff -u -r1.24 PatternFormatter.java
--- src/java/org/apache/log/format/PatternFormatter.java 13 Dec 2001 08:04:51
-0000 1.24
+++ src/java/org/apache/log/format/PatternFormatter.java 9 Feb 2002 01:22:19
+-0000
@@ -20,46 +20,66 @@
* This formater formats the LogEvents according to a input pattern
* string.
* <p>
- * The format of each pattern element can be %[+|-][#[.#]]{field:subformat}.
+ * The format of each pattern element can be
+ * <code>%[+|-][#[.#]]{field:subformat}</code>.
* </p>
* <ul>
- * <li>The +|- indicates left or right justify.
- * </li>
- * <li>The #.# indicates the minimum and maximum size of output.<br>
- * You may omit the values and the field will be formatted without size
- * restriction.<br>
- * You may specify '#', or '#.' to define an minimum size, only.</br>
- * You may specify '.#' to define an maximum size only.
- * </li>
- * <li>
- * 'field' indicates which field is to be output and must be one of
- * properties of LogEvent.<br>
- * Currently following fields are supported:
- * <dl>
- * <dt>category</dt>
- * <dd>Category value of the logging event.</dd>
- * <dt>context</dt>
- * <dd>Context value of the logging event.</dd>
- * <dt>message</dt>
- * <dd>Message value of the logging event.</dd>
- * <dt>time</dt>
- * <dd>Time value of the logging event.</dd>
- * <dt>rtime</dt>
- * <dd>Relative time value of the logging event.</dd>
- * <dt>throwable</dt>
- * <dd>Throwable value of the logging event.</dd>
- * <dt>priority</dt>
- * <dd>Priority value of the logging event.</dd>
- * </dl>
- * </li>
- * <li>'subformat' indicates a particular subformat and is currently only used
- * for category context to specify the context map parameter name.
- * </li>
+ * <li><p>The <code>+|-</code> indicates left or right justify.
+ * </p></li>
+ * <li><p>The <code>#.#</code> indicates the minimum and maximum
+ * size of output. You may omit the values and the field will be
+ * formatted without size restriction.<br />
+ * You may specify <code>#</code>, or <code>#.</code> to only
+ * define the minimum size.<br />
+ * You may specify <code>.#</code> to only define the maximum
+ * size.
+ * </p></li>
+ * <li><p><code>field</code> indicates which field is to be output and must be
+ * one of properties of LogEvent. The following fields are
+ * currently supported:
+ * <table border="0" cellpadding="4" cellspacing="0">
+ * <tr>
+ * <td><b>category</b></td>
+ * <td>Category value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>context</b></td>
+ * <td>Context value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>message</b></td>
+ * <td>Message value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>time</b></td>
+ * <td>Time value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>rtime</b></td>
+ * <td>Relative time value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>throwable</b></td>
+ * <td>Throwable value of the logging event.</td>
+ * </tr><tr>
+ * <td><b>priority</b></td>
+ * <td>Priority value of the logging event.</td>
+ * </tr>
+ * </table>
+ * </p></li>
+ *
+ * <li><p><code>subformat</code> indicates a particular subformat to
+ * use on the specified field, and is currently only supported by:
+ * <table border="0" cellpadding="4" cellspacing="0">
+ * <tr>
+ * <td><b>context</b></td>
+ * <td>Specifies the context map parameter name.</td>
+ * </tr><tr>
+ * <td><b>time</b></td>
+ * <td>Specifies the pattern to be pass to
+ * {@link java.text.SimpleDateFormat SimpleDateFormat} to format the
+time.</td>
+ * </tr>
+ * </table>
+ * </p></li>
* </ul>
* <p>A simple example of a typical PatternFormatter format:
+ * <code>%{time} %5.5{priority}[%-10.10{category}]: %{message}</code>
* </p>
- * <pre><code>%{time} %5.5{priority}[%-10.10{category}]: %{message}
- * </pre></code>
* <p>
* This format string will format a log event printing first time value of
* of log event with out size restriction, next priority with minum and maximum
size 5,
@@ -70,6 +90,7 @@
* </p>
* <pre><code>1000928827905 DEBUG [ junit]: Sample message
* </pre><code>
+ *
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Sylvain Wallez</a>
Index: src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java,v
retrieving revision 1.2
diff -u -r1.2 OrRotateStrategy.java
--- src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java 21 Aug 2001
05:08:07 -0000 1.2
+++ src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java 9 Feb 2002
+01:22:19 -0000
@@ -10,11 +10,11 @@
import java.io.File;
/**
- * Hierarchical Rotation stragety.
+ * Hierarchical rotation strategy.
* This object is initialised with several rotation strategy objects.
* The <code>isRotationNeeded</code> method checks the first rotation
* strategy object. If a rotation is needed, this result is returned.
- * If not the next rotation strategy object is asked and so on.
+ * If not, the next rotation strategy object is checked, and so on.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Carsten Ziegeler</a>
*/
Index: src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java,v
retrieving revision 1.2
diff -u -r1.2 RevolvingFileStrategy.java
--- src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java 21 Aug 2001
04:50:47 -0000 1.2
+++ src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java 9 Feb 2002
+01:22:19 -0000
@@ -13,7 +13,7 @@
import java.text.NumberFormat;
/**
- * strategy for naming log files based on appending revolving suffix.
+ * Strategy for naming log files based on appending a revolving suffix.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Bernhard Huber</a>
*/
Index: src/java/org/apache/log/output/net/SocketOutputTarget.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-logkit/src/java/org/apache/log/output/net/SocketOutputTarget.java,v
retrieving revision 1.1
diff -u -r1.1 SocketOutputTarget.java
--- src/java/org/apache/log/output/net/SocketOutputTarget.java 22 Dec 2001 11:29:29
-0000 1.1
+++ src/java/org/apache/log/output/net/SocketOutputTarget.java 9 Feb 2002 01:22:20
+-0000
@@ -18,7 +18,6 @@
* Useful for writing the output to a TCP/IP client socket.
*
* @author <a href="mailto:[EMAIL PROTECTED]";> Rajendra Ghorpade </a>
- * @version
*/
public class SocketOutputTarget extends AbstractOutputTarget
{
@@ -98,4 +97,4 @@
super.close();
m_socket = null;
}
-}
\ No newline at end of file
+}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
