svn commit: r1129357 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java

[si...@apache.org]

Author: simonetripodi
Date: Mon May 30 20:42:47 2011
New Revision: 1129357

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

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java?rev=1129357&r1=1129356&r2=1129357&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java Mon May 30 20:42:47 2011
@@ -57,12 +57,11 @@ public class PluginDeclarationRule
      * @param namespace The xml namespace in which the xml element which triggered this rule resides.
      * @param name The name of the xml element which triggered this rule.
      * @param attributes The set of attributes on the xml element which triggered this rule.
-     * @exception java.lang.Exception
+     * @exception Exception if any error occurs
      */
-
     @Override
     public void begin( String namespace, String name, org.xml.sax.Attributes attributes )
-        throws java.lang.Exception
+        throws Exception
     {
         int nAttrs = attributes.getLength();
         Properties props = new Properties();
@@ -88,6 +87,13 @@ public class PluginDeclarationRule
         }
     }
 
+    /**
+     * Helper method to declare a plugin inside the given Digester.
+     *
+     * @param digester The Digester instance to declare plugin
+     * @param props the properties where extracting plugin attributes
+     * @throws PluginException if any error occurs while declaring the plugin
+     */
     public static void declarePlugin( Digester digester, Properties props )
         throws PluginException
     {