Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@commons.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r981234 - in
 /commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations:
 DigesterLoaderBuilder.java FromAnnotationRuleProviderFactory.java
Date: Sun, 01 Aug 2010 14:41:19 -0000
To: commits@commons.apache.org
From: simonetripodi@apache.org
Message-Id: <20100801144119.DC2D323889E7@eris.apache.org>

Author: simonetripodi
Date: Sun Aug  1 14:41:19 2010
New Revision: 981234

URL: http://svn.apache.org/viewvc?rev=981234&view=rev
Log:
added missing javadoc

Modified:
    commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/DigesterLoaderBuilder.java
    commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/FromAnnotationRuleProviderFactory.java

Modified: commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/DigesterLoaderBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/DigesterLoaderBuilder.java?rev=981234&r1=981233&r2=981234&view=diff
==============================================================================
--- commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/DigesterLoaderBuilder.java (original)
+++ commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/DigesterLoaderBuilder.java Sun Aug  1 14:41:19 2010
@@ -19,23 +19,45 @@ package org.apache.commons.digester.anno
 import org.apache.commons.digester.annotations.spi.AnnotationRuleProviderFactory;
 
 /**
- * 
+ * {@link DigesterLoader} builder implementation.
  *
  * @version $Id$
  * @since 2.1
  */
 public final class DigesterLoaderBuilder {
 
+    /**
+     * Builds a new {@link DigesterLoader} using the default SPI
+     * implementations.
+     *
+     * @return a new {@link DigesterLoader} using the default SPI
+     *         implementations.
+     */
     public static DigesterLoader byDefaultFactories() {
         return new DigesterLoaderBuilder()
                     .useDefaultAnnotationRuleProviderFactory()
                     .useDefaultDigesterLoaderHandlerFactory();
     }
 
+    /**
+     * Builds a new {@link DigesterLoader} using the default
+     * {@link AnnotationRuleProviderFactory} implementation.
+     *
+     * @return the next chained builder.
+     * @see DefaultAnnotationRuleProviderFactory
+     */
     public FromAnnotationRuleProviderFactory useDefaultAnnotationRuleProviderFactory() {
         return this.useAnnotationRuleProviderFactory(new DefaultAnnotationRuleProviderFactory());
     }
 
+    /**
+     * Builds a new {@link DigesterLoader} using the user defined
+     * {@link AnnotationRuleProviderFactory} implementation.
+     *
+     * @param annotationRuleProviderFactory the user defined
+     *        {@link AnnotationRuleProviderFactory} implementation.
+     * @return the next chained builder.
+     */
     public FromAnnotationRuleProviderFactory useAnnotationRuleProviderFactory(AnnotationRuleProviderFactory annotationRuleProviderFactory) {
         if (annotationRuleProviderFactory == null) {
             throw new IllegalArgumentException("Parameter 'annotationRuleProviderFactory' must be not null");

Modified: commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/FromAnnotationRuleProviderFactory.java
URL: http://svn.apache.org/viewvc/commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/FromAnnotationRuleProviderFactory.java?rev=981234&r1=981233&r2=981234&view=diff
==============================================================================
--- commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/FromAnnotationRuleProviderFactory.java (original)
+++ commons/sandbox/at-digester/trunk/src/java/org/apache/commons/digester/annotations/FromAnnotationRuleProviderFactory.java Sun Aug  1 14:41:19 2010
@@ -20,24 +20,48 @@ import org.apache.commons.digester.annot
 import org.apache.commons.digester.annotations.spi.DigesterLoaderHandlerFactory;
 
 /**
- * 
+ * {@link DigesterLoader} builder implementation.
  *
  * @version $Id$
  * @since 2.1
  */
 public final class FromAnnotationRuleProviderFactory {
 
+    /**
+     * The {@link AnnotationRuleProviderFactory} selected in the previous
+     * chained builder.
+     */
     private final AnnotationRuleProviderFactory annotationRuleProviderFactory;
 
+    /**
+     * {@link DigesterLoader} builder implementation.
+     *
+     * @param annotationRuleProviderFactory the
+     *        {@link AnnotationRuleProviderFactory} selected in the previous
+     *        chained builder.
+     */
     protected FromAnnotationRuleProviderFactory(
             AnnotationRuleProviderFactory annotationRuleProviderFactory) {
         this.annotationRuleProviderFactory = annotationRuleProviderFactory;
     }
 
+    /**
+     * Builds a new {@link DigesterLoader} using the default
+     * {@link DigesterLoaderHandlerFactory} implementation.
+     *
+     * @return the {@link DigesterLoader}.
+     */
     public DigesterLoader useDefaultDigesterLoaderHandlerFactory() {
         return this.useDigesterLoaderHandlerFactory(new DefaultDigesterLoaderHandlerFactory());
     }
 
+    /**
+     * Builds a new {@link DigesterLoader} using the user defined
+     * {@link DigesterLoaderHandlerFactory} implementation.
+     *
+     * @param digesterLoaderHandlerFactory
+     * @return the {@link DigesterLoader}.
+     */
     public DigesterLoader useDigesterLoaderHandlerFactory(DigesterLoaderHandlerFactory digesterLoaderHandlerFactory) {
         if (digesterLoaderHandlerFactory == null) {
             throw new IllegalArgumentException("Parameter 'digesterLoaderHandlerFactory' must be not null");