svn commit: rev 31077 - in avalon/trunk/planet/facilities: . dbcp/api/src/main/org/apache/avalon/dbcp dbcp/impl/src/main/org/apache/avalon/dbcp http/impl http/impl/src/main/org/apache/avalon/http/impl jmx/util/src/main/org/apache/avalon/jmx/util

[email protected]
Newsgroups gmane.comp.jakarta.avalon.cvs
Message-ID <[email protected]>
Author: niclas
Date: Sun Aug  1 09:45:09 2004
New Revision: 31077

Modified:
   avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DbUrlNotFoundException.java
   avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DriverNotFoundException.java
   avalon/trunk/planet/facilities/dbcp/impl/src/main/org/apache/avalon/dbcp/DbcpConnectionManager.java
   avalon/trunk/planet/facilities/http/impl/build.xml
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/DumpHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ErrorPageHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ExpiryHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ForwardHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/HTAccessHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/IPAccessHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ModelHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/MsieSslHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NotFoundHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NullHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ProxyHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ResourceHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/RootNotFoundHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SecurityHandler.java
   avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SetResponseHeadersHandler.java
   avalon/trunk/planet/facilities/index.xml
   avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/DTDResolver.java
   avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/MBeanInfoBuilder.java
Log:
Fixed up so the Javadocs builds and without warnings.

Modified: avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DbUrlNotFoundException.java
==============================================================================
--- avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DbUrlNotFoundException.java	(original)
+++ avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DbUrlNotFoundException.java	Sun Aug  1 09:45:09 2004
@@ -47,11 +47,13 @@
     }
 
     /**
-     * Constructs a new exception with the specified cause and a
-     * detail message of (cause==null ? null : cause.toString())
+     * Constructs a new exception with the specified cause.
+     *
+     * <p>The message will be (cause==null ? null : cause.toString())
      * (which typically contains the class and detail message of
-     * cause). This constructor is useful for exceptions that are
-     * little more than wrappers for other throwables.
+     * cause). 
+     * This constructor is useful for exceptions that are
+     * little more than wrappers for other throwables.</p>
      *  
      * @param cause the cause
      */

Modified: avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DriverNotFoundException.java
==============================================================================
--- avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DriverNotFoundException.java	(original)
+++ avalon/trunk/planet/facilities/dbcp/api/src/main/org/apache/avalon/dbcp/DriverNotFoundException.java	Sun Aug  1 09:45:09 2004
@@ -24,7 +24,8 @@
  * @author <a href="mailto:[email protected]">Avalon Development Team</a>
  * @version $Revision: 1.1 $ $Date: 2004/05/11 21:23:02 $
  */
-public class DriverNotFoundException extends Exception {
+public class DriverNotFoundException extends Exception 
+{
 
     /**
      * Constructs a new exception with <code>null</code> as the
@@ -47,11 +48,13 @@
     }
 
     /**
-     * Constructs a new exception with the specified cause and a
-     * detail message of (cause==null ? null : cause.toString())
+     * Constructs a new exception with the specified cause.
+     *
+     * <p>The message will be (cause==null ? null : cause.toString())
      * (which typically contains the class and detail message of
-     * cause). This constructor is useful for exceptions that are
-     * little more than wrappers for other throwables.
+     * cause). 
+     * This constructor is useful for exceptions that are
+     * little more than wrappers for other throwables.</p>
      *  
      * @param cause the cause
      */
@@ -63,9 +66,9 @@
     /**
      * Constructs a new exception with the specified detail message
      * and cause.
-     * <p>
-     * Note that the detail message associated with cause is not
-     * automatically incorporated in this exception's detail message.
+     * 
+     * <p>Note that the detail message associated with cause is not
+     * automatically incorporated in this exception's detail message.</p>
      *  
      * @param message the detail message
      * @param cause the cause

Modified: avalon/trunk/planet/facilities/dbcp/impl/src/main/org/apache/avalon/dbcp/DbcpConnectionManager.java
==============================================================================
--- avalon/trunk/planet/facilities/dbcp/impl/src/main/org/apache/avalon/dbcp/DbcpConnectionManager.java	(original)
+++ avalon/trunk/planet/facilities/dbcp/impl/src/main/org/apache/avalon/dbcp/DbcpConnectionManager.java	Sun Aug  1 09:45:09 2004
@@ -254,7 +254,7 @@
 	/**
      * Returns a <code>java.sql.Connection</code> to the specified data source.
      * 
-     * @param name the name of the data source to obtain a connection to
+     * @param datasource the name of the data source to obtain a connection to
      * @return a <code>java.sql.Connection</code> to the specified data source
 	 */
 	public Connection getConnection(String datasource) throws SQLException {

Modified: avalon/trunk/planet/facilities/http/impl/build.xml
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/build.xml	(original)
+++ avalon/trunk/planet/facilities/http/impl/build.xml	Sun Aug  1 09:45:09 2004
@@ -8,7 +8,7 @@
 
   <target name="build" depends="standard.build">
   
-    <x:block name="default-context" embed="MAIN">
+    <x:block name="default-context">
       <x:component name="context" class="org.apache.avalon.http.impl.HttpContextImpl" />
       <x:component name="security-handler" class="org.apache.avalon.http.impl.SecurityHandler" />
   
@@ -38,14 +38,14 @@
     </x:block>
 
 
-    <x:block name="default-server"  embed="MAIN">    
+    <x:block name="default-server">    
       <x:component name="socketlistener" class="org.apache.avalon.http.impl.SocketListener" />
       <x:component name="ssllistener" class="org.apache.avalon.http.impl.JsseListener" />
       <x:component name="ajplistener" class="org.apache.avalon.http.impl.Ajp13Listener" />
       <x:component name="httpserver" class="org.apache.avalon.http.impl.HttpServerImpl" />
     </x:block>
     
-    <x:block name="hash-basic-auth"  embed="MAIN" >
+    <x:block name="hash-basic-auth">
       <x:component name="realm" class="org.apache.avalon.http.impl.HashUserRealm" >
         <x:parameters>
           <x:parameter name="name" value="default" />
@@ -55,7 +55,7 @@
       <x:component name="authenticator" class="org.mortbay.http.BasicAuthenticator" />
     </x:block>
   
-    <x:block name="hash-digest-auth"  embed="MAIN" >
+    <x:block name="hash-digest-auth" >
       <x:component name="realm" class="org.apache.avalon.http.impl.HashUserRealm" >
         <x:parameters>
           <x:parameter name="name" value="default" />
@@ -65,7 +65,7 @@
       <x:component name="authenticator" class="org.mortbay.http.DigestAuthenticator" />
     </x:block>
   
-    <x:block name="hash-clientcert-auth"  embed="MAIN" >
+    <x:block name="hash-clientcert-auth" >
       <x:component name="realm" class="org.apache.avalon.http.impl.HashUserRealm" >
         <x:parameters>
           <x:parameter name="name" value="default" />
@@ -75,7 +75,7 @@
       <x:component name="authenticator" class="org.apache.avalon.http.impl.ClientCertAuthenticator" />
     </x:block>
   
-    <x:block name="hash-form-auth"  embed="MAIN" >
+    <x:block name="hash-form-auth" >
       <x:component name="realm" class="org.apache.avalon.http.impl.HashUserRealm" >
         <x:parameters>
           <x:parameter name="name" value="default" />

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/DumpHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/DumpHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/DumpHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ErrorPageHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ErrorPageHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ErrorPageHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ExpiryHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ExpiryHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ExpiryHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ForwardHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ForwardHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ForwardHandler.java	Sun Aug  1 09:45:09 2004
@@ -75,7 +75,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/HTAccessHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/HTAccessHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/HTAccessHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/IPAccessHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/IPAccessHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/IPAccessHandler.java	Sun Aug  1 09:45:09 2004
@@ -75,7 +75,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ModelHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ModelHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ModelHandler.java	Sun Aug  1 09:45:09 2004
@@ -98,7 +98,7 @@
      * which we are supplied with the root composition model for 
      * the application.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/MsieSslHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/MsieSslHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/MsieSslHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NotFoundHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NotFoundHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NotFoundHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NullHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NullHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/NullHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ProxyHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ProxyHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ProxyHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ResourceHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ResourceHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/ResourceHandler.java	Sun Aug  1 09:45:09 2004
@@ -78,7 +78,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/RootNotFoundHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/RootNotFoundHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/RootNotFoundHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SecurityHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SecurityHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SecurityHandler.java	Sun Aug  1 09:45:09 2004
@@ -71,7 +71,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SetResponseHeadersHandler.java
==============================================================================
--- avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SetResponseHeadersHandler.java	(original)
+++ avalon/trunk/planet/facilities/http/impl/src/main/org/apache/avalon/http/impl/SetResponseHeadersHandler.java	Sun Aug  1 09:45:09 2004
@@ -75,7 +75,7 @@
     /**
      * Contextulaization of the Handler.
      *
-     * @param context the supplied listener context
+     * @param ctx the supplied listener context
      *
      * @exception ContextException if a contextualization error occurs
      *

Modified: avalon/trunk/planet/facilities/index.xml
==============================================================================
--- avalon/trunk/planet/facilities/index.xml	(original)
+++ avalon/trunk/planet/facilities/index.xml	Sun Aug  1 09:45:09 2004
@@ -469,4 +469,36 @@
     </plugins>
   </project>
 
+  <project basedir="javadoc" key="avalon-planet-facilities">
+    <info>
+      <group>avalon</group>
+      <name>avalon-planet-facilities</name>
+      <version>1.0</version>
+      <type>doc</type>
+      <status>SNAPSHOT</status>
+    </info>
+    <dependencies>
+      <include key="avalon-http-api" tag="api"/>
+      <include key="avalon-db-api" tag="api"/>
+      <include key="avalon-dbcp-api" tag="api"/>
+      <include key="avalon-finder-api" tag="api"/>
+      <include key="avalon-jms-api" tag="api"/>
+      <include key="avalon-jmx-api" tag="api"/>
+      
+      <include key="avalon-jmx-spi" tag="spi"/>
+      
+      <include key="avalon-db-hsql" tag="impl"/>
+      <include key="avalon-dbcp-impl" tag="impl"/>
+      <include key="avalon-finder-impl" tag="impl"/>
+      <include key="avalon-http-impl" tag="impl"/>
+      <include key="avalon-jms-impl" tag="impl"/>
+      <include key="avalon-jmx-mx4j" tag="impl"/>
+      <include key="avalon-jmx-util" tag="impl"/>
+      <include key="avalon-jmx-handler" tag="impl"/>
+      
+      <include key="servletapi"/>
+      <include key="mailapi"/>
+      <include key="geronimo-spec-jms"/>
+    </dependencies>
+  </project>
 </index>

Modified: avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/DTDResolver.java
==============================================================================
--- avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/DTDResolver.java	(original)
+++ avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/DTDResolver.java	Sun Aug  1 09:45:09 2004
@@ -29,7 +29,7 @@
  * @author <a href="mailto:[email protected]">Avalon Development Team</a>
  * @version $Revision: 1.1 $
  *
- * @todo update JavaDoc
+ * TODO: update JavaDoc
  */
 
 public class DTDResolver implements EntityResolver

Modified: avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/MBeanInfoBuilder.java
==============================================================================
--- avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/MBeanInfoBuilder.java	(original)
+++ avalon/trunk/planet/facilities/jmx/util/src/main/org/apache/avalon/jmx/util/MBeanInfoBuilder.java	Sun Aug  1 09:45:09 2004
@@ -55,7 +55,7 @@
  * @author <a href="mailto:[email protected]">Avalon Development Team</a>
  * @version $Revision: 1.2 $
  *
- * @todo update JavaDoc
+ * TODO: update JavaDoc
  */
 
 public class MBeanInfoBuilder extends AbstractLogEnabled
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.