commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang/enum package.html
Date Sat, 31 May 2003 17:16:12 GMT
ggregory    2003/05/31 10:16:11

  Modified:    lang/src/java/org/apache/commons/lang/math package.html
               lang/src/java/org/apache/commons/lang/reflect package.html
               lang/src/java/org/apache/commons/lang/exception
                        ExceptionUtils.java package.html
               lang/src/java/org/apache/commons/lang/builder package.html
               lang/src/java/org/apache/commons/lang package.html
               lang/src/java/org/apache/commons/lang/enum package.html
  Log:
  Normalize Javadocs.
  
  Revision  Changes    Path
  1.2       +1 -1      jakarta-commons/lang/src/java/org/apache/commons/lang/math/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/math/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	22 Dec 2002 16:21:03 -0000	1.1
  +++ package.html	31 May 2003 17:16:11 -0000	1.2
  @@ -1,6 +1,6 @@
   <html>
   <body>
  -A group of mathematical classes that extend java.math. This package is intended for business
  +Extends <code>java.math</code> for business mathematical classes. This package
is intended for business
   mathematical classes, not scientific ones.
   </body>
   </html>
  
  
  
  1.2       +3 -8      jakarta-commons/lang/src/java/org/apache/commons/lang/reflect/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/reflect/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	14 Nov 2002 18:50:59 -0000	1.1
  +++ package.html	31 May 2003 17:16:11 -0000	1.2
  @@ -1,15 +1,10 @@
   <html>
   <head>
  -<title>Package Documentation for org.apache.commons.lang.reflect Package</title>
   </head>
  -<body bgcolor="white">
  -<p>Package <em>org.apache.commons.lang.reflect</em> offers a collection
of utility 
  -classes that assist in reflection.
  -The aim is to create a simple, clean and clear API which can be built upon on by more 
  +<body>
  +<p>Assists in reflection with the aim to create a simple, clean and clear API which
can be built upon on by more 
   sophisticated introspection schemes as well as fixes for bugs found in various 
  -java implementations.</p>
  -
  -<h2>Contents</h2>
  +Java implementations.</p>
   
   <h2>Accessibility Rules</h2>
   <p>These determine which methods are in scope</p>
  
  
  
  1.24      +14 -11    jakarta-commons/lang/src/java/org/apache/commons/lang/exception/ExceptionUtils.java
  
  Index: ExceptionUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/exception/ExceptionUtils.java,v
  retrieving revision 1.23
  retrieving revision 1.24
  diff -u -r1.23 -r1.24
  --- ExceptionUtils.java	14 May 2003 02:59:13 -0000	1.23
  +++ ExceptionUtils.java	31 May 2003 17:16:11 -0000	1.24
  @@ -70,16 +70,18 @@
   import org.apache.commons.lang.SystemUtils;
   
   /**
  - * <p><code>ExceptionUtils</code> provides utilities for manipulating

  + * <p>Provides utilities for manipulating and examining 
    * <code>Throwable</code> objects.</p>
    *
    * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
    * @author Dmitri Plotnikov
    * @author Stephen Colebourne
  + * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
    * @since 1.0
    * @version $Id$
    */
   public class ExceptionUtils {
  +    
       /**
        * Used when printing stack frames to denote the start of a
        * wrapped exception.  Package private for accessibility by test
  @@ -223,7 +225,7 @@
       }
   
       /**
  -     * <p>Find a throwable by method name.</p>
  +     * <p>Finds a <code>Throwable</code> by method name.</p>
        * 
        * @param throwable  the exception to examine
        * @param methodName  the name of the method to find and invoke
  @@ -250,7 +252,7 @@
       }
   
       /**
  -     * <p>Find a throwable by field name.</p>
  +     * <p>Finds a <code>Throwable</code> by field name.</p>
        * 
        * @param throwable  the exception to examine
        * @param fieldName  the name of the attribute to examine
  @@ -370,14 +372,16 @@
       }
   
       /**
  -     * Equivalent to printRootCauseStackTrace(t, System.err)
  +     * Equivalent to <code>printRootCauseStackTrace(t, System.err);</code>
  +     * 
  +     * @see #printRootCauseStackTrace(Throwable,PrintWriter)
        */
       public static void printRootCauseStackTrace(Throwable t) {
           printRootCauseStackTrace(t, System.err);
       }
   
       /**
  -     * Same as printRootCauseStackTrace(t, stream), except it takes
  +     * Same as {@link #printRootCauseStackTrace(Throwable,java.io.PrintStream)}, except
it takes
        * a PrintWriter as an argument.
        */
       public static void printRootCauseStackTrace(Throwable t, PrintWriter writer) {
  @@ -390,9 +394,7 @@
   
       /**
        * Creates a compact stack trace for the root cause of the supplied 
  -     * throwable.
  -     *   
  -     * See <code>printRootCauseStackTrace(Throwable t, PrintStream s)</code>

  +     * <code>Throwable</code>.
        */
       public static String[] getRootCauseStackTrace(Throwable t) {
           Throwable throwables[] = getThrowables(t);
  @@ -418,7 +420,7 @@
       }
   
       /**
  -     * Given two stack traces, removes common frames from the cause trace.
  +     * Removes common frames from the cause trace given the two stack traces.
        * 
        * @param causeFrames   stack trace of a cause throwable
        * @param wrapperFrames stack trace of a wrapper throwable 
  @@ -474,7 +476,7 @@
       }
   
       /**
  -     * Whether an Throwable is considered nested or not.
  +     * Returns whether a <code>Throwable </code> is considered nested or not.
        *
        * @param t The <code>Throwable</code>.
        * @return boolean true/false
  @@ -581,6 +583,7 @@
               // ignore
           }
       }
  +    
       /**
        * Checks if the Throwable class has a <code>getCause</code> method.
        */
  
  
  
  1.2       +6 -5      jakarta-commons/lang/src/java/org/apache/commons/lang/exception/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/exception/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	21 Sep 2002 04:22:28 -0000	1.1
  +++ package.html	31 May 2003 17:16:11 -0000	1.2
  @@ -1,9 +1,10 @@
   <html>
   <body>
  -Provides a JDK 1.4 style Nested Exception functionality for those on prior 
  -versions. <br>
  -Also a static utility which creates a version independent Nested 
  -Exception which can handle JDK 1.4 Exceptions as well as others. <br>
  -Lastly, ExceptionUtils also contains the all-important Exception to String methods.
  +Provides JDK 1.4 style Nested Exception functionality for those on prior Java 
  +versions.
  +<p>Includes a static utility to create version independent Nested 
  +Exception which can handle JDK 1.4 Exceptions as well as others. </p>
  +<p>Lastly, {@link org.apache.commons.lang.exception.ExceptionUtils} 
  +also contains <code>Throwable</code> manipulation and examination routines.</p>
   </body>
   </html>
  
  
  
  1.3       +1 -1      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/package.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- package.html	8 Apr 2003 22:35:55 -0000	1.2
  +++ package.html	31 May 2003 17:16:11 -0000	1.3
  @@ -1,6 +1,6 @@
   <html>
   <body>
  -These builders assist with creating good and consistent <code>equals()</code>,
<code>toString()</code>, 
  +Assists in creating good and consistent <code>equals()</code>, <code>toString()</code>,

   <code>hashCode()</code>, and <code>compareTo()</code> methods.
   </body>
   </html>
  
  
  
  1.3       +1 -1      jakarta-commons/lang/src/java/org/apache/commons/lang/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/package.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- package.html	8 Apr 2003 22:36:04 -0000	1.2
  +++ package.html	31 May 2003 17:16:11 -0000	1.3
  @@ -1,6 +1,6 @@
   <html>
   <body>
  -A collection of highly reusable static utility methods, chiefly concerned 
  +Provides highly reusable static utility methods, chiefly concerned 
   with adding value to <code>java.lang</code> and other standard core classes.
   </body>
   </html>
  
  
  
  1.2       +1 -1      jakarta-commons/lang/src/java/org/apache/commons/lang/enum/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/enum/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	21 Sep 2002 04:22:28 -0000	1.1
  +++ package.html	31 May 2003 17:16:11 -0000	1.2
  @@ -1,6 +1,6 @@
   <html>
   <body>
  -An implementation of the C style 'enum' in the Java world.
  +Provides an implementation of the C style 'enum' in the Java world.
   
   The classic example being an RGB color enumeration.
   <pre>
  
  
  

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


Mime
View raw message